admin/setting/blocksettingmoodletxt

Jump to: navigation, search

Note: You are currently viewing documentation for Moodle 3.0. Up-to-date documentation for the latest stable version of Moodle may be available here: admin/setting/blocksettingmoodletxt.

MoodleTxt Settings

This page contains all the common configuration options for MoodleTxt. At the top of the page you will see two links:

ConnectTxt Accounts 
This link will take you to the ConnectTxt account admin pages, which will allow you to add, update and restrict these accounts. If you have just installed MoodleTxt, this should be your first stop.
Inbound Message Filters 
This link will take you to the inbound filter management page, which will allow you to create filters for inbound SMS messages, routing them to particular Moodle users.


Send/Receive Settings

The first 4 settings in this section relate to how MoodleTxt gets both message status updates and new inbound messages from the ConnectTxt system. By default, MoodleTxt pulls these updates on a per-request basis, whenever users visit certain pages. However, it can be configured to get these updates automatically, which improves the performance of the block and results in far fewer outbound connections. The available automatic update methods are cron and push. We highly recommend taking the time to set up push functionality, as it is the fastest and most efficient method of obtaining updates.


Field Name Field Label Description
Get_Status_On_View Automatically get status updates on "View Message" page If this box is checked, then whenever a user views the current status of a sent message, the block will first connect to the ConnectTxt system in order to fetch updates. You should uncheck this if you have configured an automatic update option as mentioned above.
Get_Inbound_On_View Automatically get inbound messages on Inbox page If this box is checked, then whenever a user views their inbox, the block will first connect to the ConnectTxt system in order to fetch new messages. You should uncheck this if you have configured an automatic update option as mentioned above.
Push_Username XML Push Username If you have set up XML push updates (highly recommended) then this is the username you provided to ConnectTxt as part of that setup. ConnectTxt uses this username to authenticate itself with your MoodleTxt installation when connecting to it.
Push_Password XML Push Password If you have set up XML push updates (highly recommended) then this is the password you provided to ConnectTxt as part of that setup. ConnectTxt uses this password to authenticate itself with your MoodleTxt installation when connecting to it.


The last two settings in this category control other parameters related to message sending via ConnectTxt.

Field Name Field Label Description
Protocol_Warnings_On Display SSL security warnings If you do not have SSL connections to the ConnectTxt server enabled, MoodleTxt will generally display warnings that your data is being transmitted in an unsecure manner. To disable these warnings, uncheck this box.
Event_Messaging_Account Event Messaging Account This is the ConnectTxt account that MoodleTxt will use when it is asked to send automatic messages out in response to system events. By extension, this is the ConnectTxt account that will be used to send any messages originating via the MoodleTxt Plus message processor plugin. If no account is selected, then MoodleTxt will be unable to send event-generated messages.


Recipient Settings

The settings in this section relate to how MoodleTxt captures user phone/name information from the Moodle system, and how it processes that information in order to send SMS messages out. (Future versions of the block will feature improvements in international phone number handling.)

Field Name Field Label Description
National_Prefix National Prefix This is the default dialling prefix for phone numbers within your country. It is the digit or set of digits that all phone numbers begin with when being dialled within the country. This defaults to 0, the UK domestic dialling prefix. (Note: If the phone numbers you enter into MoodleTxt are already formatted internationally, e.g. +441234567890, then this setting is ignored.)
Default_International_Prefix Default International Prefix This is the international dialling prefix for phone numbers within your country. This usually consists of a plus '+' sign, along with two or three digits, and is used when dialling into your country from another location. This defaults to +44, the UK international dialling prefix. (Note: If the phone numbers you enter into MoodleTxt are already formatted internationally, e.g. +441234567890, then this setting is ignored.)
Phone_Number_Source Take phone numbers from This option allows you to choose the field in your user database table that MoodleTxt will search for mobile phone numbers (phone1 or phone2). This is largely redundant in modern Moodle setups, where phone2 has been standardised as the mobile phone field, and exists for long-running installations where things may be different. If mobile phone numbers are populated to the phone1 field in your system, then select it from this drop-down.
Default_Recipient_Name Default Recipient Name When Moodle cannot find a recipient's name in the database, or cannot match an incoming phone number to any known contact, this is the name/identifier it will record against that message.


Proxy Settings

If connections between your MoodleTxt installation and ConnectTxt need to be routed via a proxy server, then you can enter the details of that proxy server in this section. Please note: MoodleTxt currently only supports proxy servers that use either BASIC authentication, or no authentication at all. Newer versions of Moodle have their own proxy settings within the system, and future versions of the block will migrate to use those settings for proxy support.

Field Name Field Label Description
Proxy_Host Proxy Address The host/IP address of your proxy server.
Proxy_Port Proxy Port The TCP/IP port your proxy server listens on for connections.
Proxy_Username Proxy Username If your proxy server requires a username for authentication, then enter it here (BASIC authentication only).
Proxy_Password Proxy Password If your proxy server requires a password for authentication, then enter it here (BASIC authentication only).


Miscellaneous Settings

This section contains any other global settings for MoodleTxt that do not fall into one of the earlier categories.

Field Name Field Label Description
jQuery_Include_Enabled Include main jQuery package MoodleTxt uses the popular jQuery library within its user interface. Some Moodle installations already include this library within their active themes. If this is the case, then attempting to load both libraries can cause problems with the system. To turn off MoodleTxt's jQuery installation and have it use the one provided with your theme, uncheck this box. (Note: You will require at least jQuery 1.6 for this to work.)
jQuery_UI_Include_Enabled Include jQuery UI Library MoodleTxt uses the jQuery User Interface library for many common widgets/user interface components. Some Moodle installations already include this library within their active themes. If this is the case, then attempting to load both libraries can cause problems with the system. To turn off MoodleTxt's jQuery UI installation and have it use the one provided with your theme, uncheck this box. (Note: You will require at least jQuery UI 1.7 for this to work.)
Show_Inbound_Numbers Show source names/numbers in inbox (Default) In a classroom situation, such as a survey, where many people can see the messages that are coming into the system, you may wish to anonymise them by hiding the source of the messages. In current versions of MoodleTxt, inbound messages are anonymised by default. To show those message sources on inbox pages by default, then check this box. Since MoodleTxt 3.0, users can override these settings for their own inboxes, so this setting is now a default.
RSS_Update_Interval RSS Update Interval This setting controls how often MoodleTxt should check with the RSS feed on the ConnectTxt servers for new updates. (This is being retired, as Moodle 2.3 and up can find updates automatically.)
RSS_Expiry_Length RSS items expire after This setting controls how long an update notification from ConnectTxt should be displayed on the MoodleTxt admin panel. (This is being retired, as Moodle 2.3 and up can find updates automatically.)