Konfigurace SMS¶

This document covers the functionality of the SMS Configuration App. For additional information about SMS service integration, please refer to the Mobile document.

SMS příkazy¶

SMS commands process SMS messages received by a DHIS2 instance, taking certain actions depending on the command and message content. Multiple SMS commands can be set up to process and handle data in multiple ways. A SMS command is an object containing the configurations for each SMS form: reporting data from phones or j2me apps, alerting users, registering patients or users, etc.

Seznam dostupných příkazů¶

To see all available commands, navigate to the "Commands" page. All commands will be listed in a table. On this page the following actions are available:

• Příkazy Přidat (1)
• Příkazy Upravit (2)
• Smazat příkazy (3)
• Příkazy hromadného mazání (4)

Smazat dostupné příkazy¶

Deleting commands can be done by individually checking the checkboxes of each command (1) that should be deleted or by selecting all displayed commands by checking the checkbox in the table head (2). After selecting the commands to delete, the "Delete selected" button needs to be clicked (3).

Aby se zabránilo náhodnému smazání, zobrazí se potvrzovací dialog.

Přidání příkazů¶

Caution

Commands are not active immediately after they are added! They must then be edited in order to configure the necessary fields!

After clicking on the "Add command" button in the command overview page, a dynamic form will appear. Depending on the parser type, different inputs will be displayed:

Typ analyzátoru	Uživatelská skupina	Program	Fáze programu	Datová sada
Výstražný parter	✓	✕	✕	✕
Parser registrace události	✕	✓	✓	✕
J2ME parser	✕	✕	✕	✓
Analyzátor klíčových hodnot	✕	✕	✕	✓
Analyzátor zadávání dat fáze programu	✕	✓	✓	✕
Analyzátor registrace sledované entity	✕	✓	✕	✕
Neregistrovaný analyzátor	✓	✕	✕	✕

Analyzátor registrace události¶

These commands can have short codes for their associated program stage. Only programs of type "Event program" can be chosen for this command. Therefore only one program stage exists, which will be selected automatically.

Analyzátor zadávání dat fáze programu¶

These commands can have short codes for their associated program stage. Only programs of type "Tracker program" can be chosen for this command. Unlike "Event registration" parsers, a program stage has to be chosen for this parser type.

Úpravy příkazů¶

When editing commands, changing the parser type as well as the additional data supplied when adding the command is not possible. The only way this is currently possible is by creating a new command and deleting the old one.

There are certain parameters which are common to all SMS Command types. These parameters have default values configured in the system, if user does provide any value to these parameters then those default ones will be used. Here is the list of those parameters

Tato běžná pole jsou:

Parametr	Typ	Popis
Oddělovač pole	Řetězec	Chcete-li poskytnout vlastní oddělovač polí. Výchozí je „|“
Odpověď na zprávu, pokud nejsou odeslány žádné kódy (pouze příkaz)	Řetězec	Chcete-li odeslat zprávu, pokud není v zadávání textu SMS nalezen žádný kód. Výchozí hodnota je "Chybí parametr"
Nesprávný formát zprávy	Řetězec	Poskytnout zprávu, pokud příkaz není správně naformátován. Příkaz by měl být naformátován podle oddělovače hodnot kódu. Tato zpráva bude také odeslána zpět, pokud chybí některý povinný parametr.
Žádná uživatelská zpráva	Řetězec	Poskytnout zprávu, pokud není telefonní číslo pro odesílání registrováno v DHIS2.
Uživatel patří do více než jedné zprávy Org. jednotky	Řetězec	Některé typy SMS příkazů vyžadují, aby uživatel (načtený z telefonního čísla odesilatele) byl spojen pouze s jednou organizační jednotkou. Tuto zprávu lze nakonfigurovat tak, aby byla odeslána zpět v případě, že požadavek není splněn.
Zpráva o úspěchu	Řetězec	Poskytnout zprávu, která bude odeslána po úspěšném dokončení procesu.

Some commands have the option to add short codes, which are explained in the individual sections for each parser type down below.

Úprava příkazů analyzátoru výstrah¶

When editing an alert parser command, only two fields are editable, the fields that are shared between most parser types are not present:

• Jméno (vyžadováno)
• Potvrdit zprávu

Obě jsou textová pole.

Úprava příkazů analyzátoru registrace události¶

Commands of this parser type have all the shared fields. Additionally short codes can be defined. A short code can be added for every data element connected to the program stage that was selected when adding the command:

Úpravy příkazů analyzátoru J2ME¶

Commands of this parser type have all the shared fields. The SMS command will have a dataset because those are used for reporting data. If data is reported for a Period which is already approved then SMS response will be sent back containing information about approval status of the period. Additionally short codes can be defined. Each command is connected to a dataset. The dataset has data elements, which have category combos, which have at least one category option combo. For every existing "data element - category option combo" combination, a short code can be provided.

Required values notice Make sure at least one SMS short code is provided when completeness method "Receive at least one data value" is chosen, otherwise received messages will not be processed.

Vzorce krátkého kódu¶

Each short code can have an optional formula. By providing a formula, the value of a different data element can be either added or subtracted.

This can be done by clicking the "Add formula" / "Edit formula" button below the short code's input field:

When clicking the button, a modal will appear which offers a dropdown to select a data element, and the formula operator, which can be either "+" or "-":

By clicking "Save", the formula will be added to the main edit form, it does not get saved to the command automatically! In order to save a changed formula, you need to submit the whole form.

Odstranění vzorce krátkého kódu¶

If a short code has a formula, it can be removed by clicking the "Edit formula" button. The modal that will appear, has a button "Remove". By clicking that button, the formula will be removed from the short code in the main form and the modal will close. It does not get saved to the command automatically! In order to save the removal of the formula, you need to submit the whole form.

Úprava příkazů analyzátoru klíčových hodnot¶

This command type works identically to J2ME parser commands work. Please check the documentation above.

Úpravy příkazů analyzátoru zadávání dat fáze programu¶

Commands of this parser type have all the shared fields. Additionally short codes can be defined. A short code can be added for every data element connected to the program stage that was selected when adding the command:

Úprava příkazů analyzátoru registrace trasované entity¶

Commands of this parser type have all the shared fields. Additionally short codes can be defined. A short code can be added for every tracked entity attribute connected to the program that was selected when adding the command:

Úprava neregistrovaných příkazů analyzátoru¶

This command type works identically to alert parser commands work. Please check the documentation above.

SMS brány¶

An SMS gateway lets a DHIS2 instance send and receive SMS messages. Different gateway types can be added and configured below. At least one gateway is needed to send and receive SMS messages. Load balancing will use all gateways if there are multiple available.

Služba SMS podporuje čtyři typy bran: * Generické brány * BulkSMS brány * Clickatell brány * SMPP brány

Výpis bran¶

To see all available gateways, navigate to the "Gateway configurations" page. All gateways will be listed in a table. On this page the following actions are available:

• Přidat brány (1)
• Upravit brány (2)
• Smazat brány (3)
• Hromadné mazání bran (4)
• Nastavit výchozí bránu (5)

Přidání bran¶

After clicking on the "Add gateway" button in the gateway configurations overview page, a dynamic form will appear. It's devided into two sections:

1. Typ brány (1)
2. Konfigurace brány závisí na typu brány (2)

For more details about configuring gateways, please refer to the Gateway Configurations section of the "Mobile" maintenance documentation.

Úpravy bran¶

Editing is similar to adding gateways with the exception that the gateway type cannot be altered. If a gateway has the wrong type, it needs to be deleted and added again. For more information how to edit gateways, please refer to the "Adding gateways" section above.

Zobrazit příchozí SMS¶

To see all inbound sms, navigate to the "Received" page. All received sms will be listed in a paginated table. On this page the following actions are available:

• Filtrování příchozích SMS (1)
• Mazání SMS (2)
• Hromadné mazání SMS zpráv (3)

Filtrování¶

Resetování filtrů¶

Všechny nastavené filtry lze resetovat kliknutím na tlačítko „Resetovat filtr“.

Filtrování podle stavu¶

Seznam příchozích SMS lze filtrovat podle následujících stavů:

• Vše
• Selhalo
• Příchozí
• Zpracováno
• Zpracovávání
• Odesláno
• Nezpracovaná

Filtrování podle telefonního čísla¶

By entering a phone number in the input field above the table with the SMSes, the table can be filtered by that phone number.

Zobrazit odchozí SMS¶

This section is identical to the "Inbound"/"Received" SMSes section, with only one difference: The list cannot be filtered by a phone number. Please refer to the "View inbound SMS" section.