{"type":"doc","content":[{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"This page is outdated and no longer receives updates!","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Transport Layer","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Overview","type":"text"}]},{"type":"paragraph","content":[{"text":"Mobile devices and the OpenMRS server need to communicate with each other in certain ways. The server needs to export forms to the mobile device, holding data which has to be displayed on the handset or specifying which data has to be collected. Further, collected data has to be transmitted to the OpenMRS server. The transport layer will provide a secure and flexible way for all kind of data transport. There are multiple ways in which client and server could interact with each other, including internet (HTTP over WAP or IP), SMS, WIFI or serial connection (cable, irda or bluetooth).","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Requirements","type":"text"}]},{"type":"panel","attrs":{"panelType":"custom"},"content":[{"type":"paragraph","content":[{"text":"*","type":"text"},{"text":"Flexibilty:","type":"text","marks":[{"type":"strong"}]},{"text":" Mobile devices may support numerous different ways to transmit data. The transport layer should be designed in a generic way, so that it can be easily extended to support additional transport methods.","type":"text"},{"type":"hardBreak"},{"text":"*","type":"text"},{"text":"Reliability:","type":"text","marks":[{"type":"strong"}]},{"text":" The sending device should be able to determine the state of the transmission. That is, it should be able to tell if the transmission was successful or not or if the data is still queued by an intermediate station. This information is needed to decide whether the data should be re-transmitted or if the data can be deleted on the source device. Also, it should be possible to detect data corruption, possibly by sending a hash value together with data payload.","type":"text"},{"type":"hardBreak"},{"text":"*","type":"text"},{"text":"Security:","type":"text","marks":[{"type":"strong"}]},{"text":" The data may contain sensitive information. Therefore it should be ensured that it will be transmitted in a secure way. The transport layer should provide encryption of the data, at least the cases when the chosen transport mechanisn is inherently insecure (e.g. when the data in sent through internet).","type":"text"},{"type":"hardBreak"},{"text":"**Platform independency: * Especially the transport layer component for mobile devices has to support various devices with very different capabilities. Using J2ME, Mobile Phones, Smartphones and PDAs can be supported.","type":"text"},{"type":"hardBreak"},{"text":"*","type":"text"},{"text":"Transparency:","type":"text","marks":[{"type":"strong"}]},{"text":" Sender and receiver should not have to bother how the data will reach it's destination (i.e. directly or through another device). It is up to the transport layer to hide such details where possible. Anyhow, the sender might have to choose the appropriate transport method in cases there are multiple transport methods supported by a particular device.","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Ways of Transport","type":"text"}]},{"type":"paragraph","content":[{"text":"The transport layer should not be limited to certain modes of transport. More transport methods might be added in the future. Still, the transport method can be divided into the following groups:","type":"text"}]},{"type":"panel","attrs":{"panelType":"custom"},"content":[{"type":"paragraph","content":[{"text":"*","type":"text"},{"text":"Messaging:","type":"text","marks":[{"type":"strong"}]},{"text":" Send data using the short messaging service.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"Problems:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph"},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The sender needs to know the recipient's ","type":"text"},{"text":"MSISDN","type":"text","marks":[{"type":"link","attrs":{"href":"http://en.wikipedia.org/wiki/MSISDN"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Sending an SMS causes costs","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The capacity of a short message is limited to 160 characters. This is certainly not enough for transmission of patient data or forms (TODO: check on binary messages). However, SMS might be a very useful way to notify a mobile device that there is data available. The mobile device then can initiate a (HTTP) connection to the server to download the data. Mobile devices are able to listen on a certain port for incoming SMS using the ","type":"text"},{"text":"Push Registry","type":"text","marks":[{"type":"link","attrs":{"href":"http://developers.sun.com/mobility/midp/articles/pushreg/"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"As opposed to mobile devices, which can be expected to support SMS, additional hard- and software will be required on the server side (GSM modem, SMS server software).","type":"text"}]},{"type":"paragraph","content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"__confluenceADFMigrationUnsupportedContentInternalExtension__","text":"","parameters":{"cxhtml":"

*Internet connection: The sender opens an internet connection and transmits the data via a HTTP POST request.

","block-inline":true,"nestedContent":{"type":"doc","content":[{"type":"panel","attrs":{"panelType":"custom"},"content":[{"type":"paragraph","content":[{"text":"*","type":"text"},{"text":"Internet connection:","type":"text","marks":[{"type":"strong"}]},{"text":" The sender opens an internet connection and transmits the data via a HTTP POST request.","type":"text"}]}]}],"version":1}}}}]},{"type":"paragraph","content":[{"text":"Problems:","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"It is impossible for the server to initiate an internet connection to a mobile device.","type":"text"},{"type":"hardBreak"},{"text":"Possible solutions:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The client performs checks for available data periodically.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The server may send a SMS to inform the client that there is data available for it. The client could listen on a certain port to incoming SMS (using the ","type":"text"},{"text":"Push Registry","type":"text","marks":[{"type":"link","attrs":{"href":"http://developers.sun.com/mobility/midp/articles/pushreg/"}}]},{"text":") and then initiate an internet connection to the server to retrieve the data.","type":"text"}]},{"type":"paragraph","content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"__confluenceADFMigrationUnsupportedContentInternalExtension__","text":"","parameters":{"cxhtml":"

*Direct networking: Sender and recipient are connected through a peer-to-peer network.

- Sneakernet*[The data is saved on a removable storage media and then carried to the target device. In case of mobile devices, the storage media might be a flash memory card. When using e.g. a laptop as an intermediate station, possible storage media include floppy disks, USB sticks and compact disks.

","block-inline":true,"nestedContent":{"type":"doc","content":[{"type":"panel","attrs":{"panelType":"custom"},"content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph"},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Sneakernet*[The data is saved on a removable storage media and then carried to the target device. In case of mobile devices, the storage media might be a flash memory card. When using e.g. a laptop as an intermediate station, possible storage media include floppy disks, USB sticks and compact disks.","type":"text"}]}]}]}]}]}]}],"version":1}}}}]},{"type":"paragraph"}]}]}]}]},{"type":"mediaSingle","attrs":{"layout":"align-start"},"content":[{"type":"media","attrs":{"width":486,"id":"f581ae05-8aad-428e-8ca0-0601f9c062d5","collection":"contentId-25520646","type":"file","height":306}}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Use Case Scenarios","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"1. Server exports data to mobile client(s)","type":"text"}]},{"type":"paragraph","content":[{"text":"The server wants to send data, i.e. a set of XForms to a number of clients.","type":"text"},{"type":"hardBreak"},{"text":"Problem:","type":"text","marks":[{"type":"strong"}]},{"text":" The server needs to address each clients using some kind of unique identifier.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"2. Client sends data directly to server","type":"text"}]},{"type":"paragraph","content":[{"text":"The client sends the collected data by connecting to the server directly using an internet connection. The client receives immediate feedback about success of the transmission. If there is data available for the client the server might include it in the response, so all transfer can be done within a single session.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"3. Client stores data on removable storage media","type":"text"}]},{"type":"paragraph","content":[{"text":"The client saves the data on a removable storage media which then can be carried to the final destination or an intermediate device.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"4. Client sends data via an intermediate station","type":"text"}]},{"type":"paragraph","content":[{"text":"It is not possible for the client to initiate a direct connection to the server. Instead, the client sends the data (together with the final recipient's address) to another device (possibly a laptop), which in turn has the ability to connect to the server directly (if not immediately, then later on). The second device queues the data and may send it to the server using a direct connection and notify the actual sender (the first device) about state of the transmission (success, failure, still queued). The intermediate station might also save the data on a removable storage media for physical transport. In the latter case, it might be impossible to provide a status report about successful transmission to the sender.","type":"text"}]},{"type":"paragraph","content":[{"text":"The client might connect to the intermediate device via serial connection (cable, bluetooth) or Wi-Fi.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Registration","type":"text"}]},{"type":"paragraph","content":[{"text":"We need a way to announce available mobile clients to the server. Several methods may be possible:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Clients should be able to register themselves at a server by making a HTTP request and retrieve their unique id in the response.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Alternatively, it should be possible to enter new devices directly at the server. In such cases, one has to enter the MSISDN. The server could inform the device through SMS that is should connect to the server and retrieve it's unique identifier.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Together with installation: When the mobile client is being installed via OTA, the unique identifier could already be included in the JAD file. Still, the server needs know the MSISDN of the device.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Problems:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"What to do in cases when the server is not accessible through internet connections and does not provide functionality for sending SMS?","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The server needs the MSISDN of the mobile. It is not possible for a MIDlet to access the devices MSISDN, so it must be entered by the user, otherwise it cannot transmitted to the server through the registration request.","type":"text"}]}]}]},{"type":"mediaSingle","attrs":{"layout":"align-start"},"content":[{"type":"media","attrs":{"width":615,"id":"0f45350a-13ea-4120-999d-5f4f51ae6745","collection":"contentId-25520646","type":"file","height":469}}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Implementation","type":"text"}]},{"type":"paragraph","content":[{"text":"Draft","type":"text","marks":[{"type":"link","attrs":{"href":"http://en.wikipedia.org/wiki/Sneakernet"}}]},{"text":":]","type":"text"}]},{"type":"paragraph","content":[{"text":"The transport layer will consist of three components:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A ","type":"text"},{"text":"server component","type":"text","marks":[{"type":"em"}]},{"text":" that will be responsible for sending data to mobile devices as well as for handling incoming data from mobile devices. It will export data to mobile clients and receive data send back to the server by those clients.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A ","type":"text"},{"text":"client component","type":"text","marks":[{"type":"em"}]},{"text":" that will handle all data transmission on the mobile device. It has to be able to receive data sent from the server to the particular device. Further, it should allow sending data back to a server either directly or through an intermediate station.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"An ","type":"text"},{"text":"intermediate device component","type":"text","marks":[{"type":"em"}]},{"text":" that offers a service to other devices to forward their to the actual destination. It will act as some kind of message queue. Any device may send it's data to this component along with the final destination address. This component may run i.e. on a desktop PC or a laptop.","type":"text"},{"type":"hardBreak"},{"text":"Even though these three components are independent they may share common parts of code.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Open questions","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The mobile client needs to know to which server it has to deliver the data. This information could be part of the data exported from the server. Is the destination server always the same server that exported the data? An (alternate) destination could be entered on the device when the data transmission process is initiated by the user.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Is the destination OpenMRS server always accessible through an internet connection. (Probably not.)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"We need a way to address each device (client as well as server) using some kind of unique identifier.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"For mobile devices the MSISDN must be available for the server.","type":"text"}]}]}]}],"version":1}