This repository has been archived by the owner on Sep 9, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
2 additions
and
131 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,132 +1,3 @@ | ||
| <img src="https://cloud.githubusercontent.com/assets/668093/12567089/0ac42774-c372-11e5-97eb-00baf0fccc37.jpg" alt="OpenMRS"/> | ||
|
|
||
| # OpenMRS SMS Module | ||
|
|
||
| ## Description | ||
|
|
||
| The SMS module allows to integrate with the API of SMS providers through the HTTP(s) protocol. Can be used both to send | ||
| outgoing messages, as well as to receive inbound messages. Thanks to a flexible, template based configuration scheme it | ||
| can integrate with a wide range of SMS providers including, but not limited to, Nexmo, Twilio, Voto or IMI mobile. | ||
| The module also provides retry and auditing functionality. | ||
|
|
||
| For successful send sms proper template and configuration are required. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| #### JDK 1.7 and/or JDK 1.8 | ||
| To make sure that you have JDK installed properly enter in console or terminal: | ||
|
|
||
| on Windows: | ||
|
|
||
| `"%JAVA_HOME%/bin/java.exe" -version` | ||
|
|
||
| on Linux/Mac: | ||
|
|
||
| `"$JAVA_HOME/bin/java" -version` | ||
|
|
||
| It should display your java version. If you do not have installed Java please follow | ||
| [Oracle's guide](https://docs.oracle.com/cd/E19182-01/820-7851/inst_cli_jdk_javahome_t/) to install. | ||
|
|
||
|
|
||
| #### Maven 3.x | ||
| To make sure that you have Apache Maven 3.x installed, open a console/terminal and enter: | ||
|
|
||
| `mvn -v` | ||
|
|
||
| You should see your Maven version. If you do not have installed please go ahead and install it. | ||
| Here are tutorials for [Windows](https://docs.oracle.com/cd/E19182-01/820-7851/inst_cli_jdk_javahome_t/), | ||
| [MacOSX](https://www.journaldev.com/2348/how-to-install-maven-on-mac-os-x-mavericks-10-9), | ||
| [Ubuntu](https://www.mkyong.com/maven/how-to-install-maven-in-ubuntu/). | ||
|
|
||
| #### OpenMRS SDK | ||
|
|
||
| To start work with OpenMRS modules you will need to setup the OpenMRS SDK. In terminal or console enter a command: | ||
|
|
||
| `mvn org.openmrs.maven.plugins:openmrs-sdk-maven-plugin:setup-sdk` | ||
|
|
||
| After proper command executing you can make sure the OpenMRS SDK works fine. | ||
|
|
||
| `mvn openmrs-sdk:help` | ||
|
|
||
| It should produce the following output: | ||
|
|
||
| [INFO] Scanning for projects... | ||
|
|
||
| [INFO] | ||
|
|
||
| [INFO] ------------------------------------------------------------------------ | ||
|
|
||
| [INFO] Building Maven Stub Project (No POM) 1 | ||
|
|
||
| [INFO] ------------------------------------------------------------------------ | ||
|
|
||
| [INFO] | ||
|
|
||
| [INFO] --- openmrs-sdk-maven-plugin:3.0.0:help (default-cli) @ standalone-pom --- | ||
|
|
||
| OpenMRS SDK *your-version-of-OpenMRS-SDK* | ||
|
|
||
| If that is the case, you have installed the SDK successfully. | ||
|
|
||
| For more info, see SDK documentation: https://wiki.openmrs.org/display/docs/OpenMRS+SDK | ||
|
|
||
| ## Building from Source | ||
| You will need to have Java 1.8+ and Maven 3.x+ installed. Use the command 'mvn package' to | ||
| compile and package the module. The .omod file will be in the omod/target folder. | ||
|
|
||
| Alternatively you can add the snippet provided in the [Creating Modules](https://wiki.openmrs.org/x/cAEr) page to your | ||
| omod/pom.xml and use the mvn command: | ||
|
|
||
| mvn package -P deploy-web -D deploy.path="../../openmrs-1.8.x/webapp/src/main/webapp" | ||
|
|
||
| It will allow you to deploy any changes to your web | ||
| resources such as jsp or js files without re-installing the module. The deploy path says | ||
| where OpenMRS is deployed. | ||
|
|
||
| ## Installation | ||
| 1.Build the module to produce the .omod file using: | ||
|
|
||
| `mvn clean install` | ||
|
|
||
| You can build .omod file skipping the tests: | ||
|
|
||
| `mvn clean install -DskipTests` | ||
|
|
||
| It creates *.omod file in omod/target directory. | ||
|
|
||
| **Note:** Building the module takes some time because during module building static code analysis are executed | ||
| and the UI is building using the npm tool. If you want to build the module faster (during the developing) then | ||
| you can use one (or both) of following maven profiles: | ||
|
|
||
| _no-npm_ - disable building module UI (Note: the UI must be at least one time built before and the built zip file won't | ||
| be deleted during maven 'clean' phase) | ||
|
|
||
| Example of usage: `mvn clean install -P no-npm` | ||
|
|
||
| _dev_ - disable executing of static code analysis tools | ||
|
|
||
| Example of usage: `mvn clean install -P dev` | ||
|
|
||
| You can use both profiles in the same time. | ||
|
|
||
| Example of usage: `mvn clean install -P dev,no-npm` | ||
|
|
||
| ##### Code coverage | ||
|
|
||
| You can also build module with code coverage profile using: | ||
|
|
||
| `mvn clean install -P code-coverage` | ||
|
|
||
| Apart from creation .omod file it generates code coverage reports which are available in: | ||
|
|
||
| _api/target/site/jacoco/index.html_ | ||
|
|
||
| _omod/target/site/jacoco/index.html_ | ||
|
|
||
| 2.Use the OpenMRS Administration > Manage Modules screen to upload and install the .omod file. | ||
|
|
||
| If uploads are not allowed from the web (changable via a runtime property), you can drop the omod | ||
| into the ~/.OpenMRS/modules folder. (Where ~/.OpenMRS is assumed to be the Application | ||
| Data Directory that the running openmrs is currently using.) After putting the file in there | ||
| simply restart OpenMRS/tomcat and the module will be loaded and started. | ||
| # Connect for Life has moved | ||
|
|
||
| The CFL distribution and its all repositories can now be found under its own [organization](https://github.com/ConnectForLife/). |