SMS handler setup - Revision history

Jillhinchliffe at 10:52, 22 June 2018

2018-06-22T10:52:38Z

Jillhinchliffe: /* Reply SQL */

2018-06-22T10:39:51Z

‎Reply SQL

Angus at 10:10, 8 July 2015

2015-07-08T10:10:52Z

Angus at 15:27, 2 September 2014

2014-09-02T15:27:06Z

Angus at 15:25, 2 September 2014

2014-09-02T15:25:13Z

Angus at 15:24, 2 September 2014

2014-09-02T15:24:10Z

Angus at 15:23, 2 September 2014

2014-09-02T15:23:05Z

Angus at 15:19, 2 September 2014

2014-09-02T15:19:38Z

Angus: /* Table name */

2014-09-02T15:18:12Z

‎Table name

Catriona: Marked this version for translation

2014-09-01T11:02:11Z

Marked this version for translation

Show changes

@@ Baris 114: / Baris 114: @@
 ===== Lookup code ===== <!--T:20-->
-This is a alpha (letters only) code (one or more letters), which is used to look up a value from a reference table. This is the most common way to refer to reference table values.
+This is an alpha (letters only) code (one or more letters), which is used to look up a value from a reference table. This is the most common way to refer to reference table values.
 ===== Integer ===== <!--T:21-->

@@ Baris 53: / Baris 53: @@
 <!--T:7-->
-Helpful functions that may be included in replay SQL include:
+Helpful functions that may be included in reply SQL include:
 * get_string(key varchar, userid integer): returns a defined string (indexed by the key) in the user's preferred language
 * get_user_lang(userid integer): return the language code for the user. This is useful if directly accessing data from a translated array field.
 * add_checkdigit(code integer): when returning a numeric code (case ID, program ID etc), a check digit is used to ensure that there are no typographical errors. This function adds a check digit to the raw code. All ID codes should have a check digit added, as if they are used in a message without the check digit, it will be interpreted as an error by the system.
-* format(format_string varchar, input_string varchar,...): This is a standard PostgreSQL function to format a string with a list of replaceable variables. The string should contain one or more %s place holders, which are replaced with the value of the variables specified.
+* format(format_string varchar, input_string varchar,...): This is a standard PostgreSQL function to format a string with a list of replaceable variables. The string should contain one or more %s placeholders, which are replaced with the value of the variables specified.
-* string_agg(string varchar, separator varchar): another standard SQL function that aggregates string from multiple rows (when using a 'group by' clause) into a single concatenated value, with each row's string be separated by the separator. This is useful when the message might insert data into multiple rows, and the reply needs to summarise the data from these rows.
+* string_agg(string varchar, separator varchar): another standard SQL function that aggregates string from multiple rows (when using a 'group by' clause) into a single concatenated value, with each row's string separated by the separator. This is useful when the message might insert data into multiple rows, and the reply needs to summarise the data from these rows.
 <!--T:8-->

@@ Baris 164: / Baris 164: @@
 ===== Integer or Date ===== <!--T:33-->
-The SQL is optional. If provided it is used for range checking. It should return a single boolean value. For example:
+The SQL is required. If provided it is used for range checking. It should return a single boolean value. For example:
   <!--T:34-->

@@ Baris 249: / Baris 249: @@
 = Testing the message function = <!--T:50-->
-To test a new function, use the menu Admin | Test SMS Message. This allows a message to be composed and submitted to the system as if it were being sent by SMS. The message is inserted into the inbox, normal processing follows, and any response messages are inserted into the outbox. However no SMS is actually sent (the outgoing messages are displayed on the web interface). Note that any data submitted is inserted into the database so be sure to delete any test data afterwards.
+To test a new function, use the Instant Messaging system. This allows a message to be composed and submitted to the system as if it were being sent by SMS. The message is inserted into the inbox, normal processing follows, and any response messages are inserted into the outbox and returned to the sender via IM. Note that any data submitted is inserted into the database so be sure to delete any test data afterwards if using the live server
 </translate>

@@ Baris 163: / Baris 163: @@
 select id from drugs where upper(code) = upper(trim(%s))
-=== Integer === <!--T:33-->
+===== Integer or Date ===== <!--T:33-->
 The SQL is optional. If provided it is used for range checking. It should return a single boolean value. For example:
@@ Baris 169: / Baris 169: @@
 select %s between 0 and 1000
-=== Text array === <!--T:35-->
+===== Text array ===== <!--T:35-->
 The SQL is required. It returns an array of ID values for the codes in the input array. The requirements are rather special:
 * two %s parameters
@@ Baris 188: / Baris 188: @@
   AND (valid_to IS NULL OR valid_to >= CURRENT_DATE)
-=== Boolean === <!--T:37-->
+===== Boolean ===== <!--T:37-->
 The SQL is optional. If present, it returns a boolean value for the submitted code. For example:
   select case upper(trim(%s))

@@ Baris 157: / Baris 157: @@
 This is a select statement with a different purpose depending on the field type. When not required, it can be left blank. When used, it should contain a single %s value which is replaced with the value of the field. Return types vary with the field type.
-=== Lookup code === <!--T:31-->
+===== Lookup code ===== <!--T:31-->
 The SQL returns the id from the reference table of the value submitted. The SQL is required in this case. For example:

@@ Baris 110: / Baris 110: @@
 The following data types are defined:
-=== Numeric code === <!--T:19-->
+===== Numeric code ===== <!--T:19-->
 This is a number containing a check digit. Its main use is case ID, but it is used in a number of other situations where users need to send and receive numeric codes.
-=== Lookup code === <!--T:20-->
+===== Lookup code ===== <!--T:20-->
 This is a alpha (letters only) code (one or more letters), which is used to look up a value from a reference table. This is the most common way to refer to reference table values.
-=== Integer === <!--T:21-->
+===== Integer ===== <!--T:21-->
 This is a simple integer, used for counts in the data submitted (number of animals slaughtered, vaccinated, sick etc.)
-=== Location === <!--T:22-->
+===== Location ===== <!--T:22-->
 This is a location code, which can be a full version (8 digits in the new system, 10 in the old), or short (just the last digits below the users area of responsibility).
-=== Boolean === <!--T:23-->
+===== Boolean ===== <!--T:23-->
 A single letter text code that can take two values, defaulting to Y (Ya, yes), and T (tidak, no). SQL can be used to define other alternatives.
-=== Text === <!--T:24-->
+===== Text ===== <!--T:24-->
 Free text with any characters. This normally has to be the last field in a message as it is difficult to parse.
-=== Float === <!--T:25-->
+===== Float ===== <!--T:25-->
 A number that may contain a decimal point, for example, drug doses or coordinates.
-=== Integer code === <!--T:26-->
+===== Integer code ===== <!--T:26-->
 An integer used to lookup a value from a reference table. This is not commonly used (alpha codes are used instead).
-=== Text array === <!--T:27-->
+===== Text array ===== <!--T:27-->
 A field containing one or more lookup codes (alpha codes referencing values in a table). These values are parsed and inserted into a single array field in the data table. In this way, multiple values can be handled as a single field type. This is used for signs and differential diagnoses, for example. Care is required to ensure that parsing is unambiguous (last field, or surrounded by numeric fields).
 == Optional == <!--T:28-->

@@ Baris 101: / Baris 101: @@
 Select the existing message defined in the previous step
-== Order == <!--T:16-->
+== Natorder == <!--T:16-->
-Type an integer to define the order of fields in the SMS
+Natural order. Type an integer to define the order of fields in the SMS. Each field must have a different sequential value.
 == Name == <!--T:17-->

@@ Baris 32: / Baris 32: @@
 == Table name ==
 This is the name of an existing database table into which the received data will be inserted. Type the name of the table.
 == Error message ==
 This is a key to a string which will be used as the error message if the general format of the message is incorrect. Normally it is in the form ''message_type''_error. For example, for an OB message, the name would be OB_error.