...
Team Management module is an an OpenMRS module module developed by Interactive Health Solutions for OpenSRP project that helps the user to manage multiple teams of a project. It allows users to add/edit/delete team role, team and team members. Each team hierarchy can own any team, team has only one team leadsupervisor. User can easily transfer member to another team/team hierarchy, make a new team supervisor, make new team leadhierarchy supervisor (which itself would be another team hierarchy), view team hierarchy/members/teams, view team hierarchy/team/team members history.
The features are different for different users and the functionality varies according to user roles. Furthermore, it provides data via REST calls.
2 Requirements
2.1
...
Download and install from here. You need to select the correct JDK for windows depending on your windows operating system (32-bit or 64-bit). You don’t need to make any changes to the default settings.
2.2 Install Apache Tomcat 7.0:
Download and install from here. Choose '32-bit/64-bit Windows Service Installer' in Binary Distributions.
Run the downloaded installer.
After finishing installer, run configuration wizard.
Assign the appropriate ports and login credentials for tomcat. Credentials will be used to deploy web applications on the server, while the assigned port no. to Http/1.1 Connector port will be used to access the web apps deployed on the tomcat server. Hence, these ports shouldn’t be blocked by any service.
If JRE was previously installed successfully, the following page will show the jre6/7 path noted earlier by default.
Choose the location “c:\apache-tomcat-6.0” or “c:\apache-tomcat-7.0” instead of default location.
After completing all the Apache Tomcat installation steps, start browser. Type in http://localhost:< Connector Port> in address bar and Go. If installation was successful, you should be able to see the Apache Tomcat Homepage.
2.3 Install OpenMRS (Open Medical Record System) 1.9.2 or higher:
Download and install OpenMRS from here. Place the war file in the “webapps” folder in tomcat directory. Run tomcat and then type “localhost:8080/openmrs” and the setup will begin. Let the defaults be as they are and proceed with the setup. After finishing the setup, type “localhost:8080/openmrs”. Type “admin” as username and “Admin123” as password.
2.4 Required Modules
Add the following modules from OpenMRS Module Repository
- OpenMRS UI Framework 3.3.2
- Rest Web Services 2.11.dae2e2
Then add the Team Management module by adding the .omod file provided to you.
2.5 Required tables in database
Import the tables “team”, “team_member”, “team_lead” and “member_location” in your OpenMRS schema. These will be provided to you in a single sql file.
3 Using Team Management Module
3.1 Navigating to main page
After logging in to OpenMRS, go to Administration. After that click on “Manage Teams” under the heading “Team Management Module”.
3.2 Team
3.2.1 Add Team
After clicking on “Manage Teams”, you’ll be redirected to this page. By clicking on “Add Team” you’ll be redirected to the page to add team. Same page is used for adding members too but it will be discussed later.
After clicking on “Add Team”, you will be redirected to the page below.
Fill in the data and click on “Save”. The retire team option can be used while adding the team if the module is integrated in the middle of project and some of the teams were there which are now retired. After clicking on “Save”, you would see the success message in green right above the “Add Team” heading. Also, the page is ready to add another team too. You can go to the team list again by clicking “Back to teams”.
You would see the added team now in the list.
3.2.2 Editing Team
To edit a team, click on the edit button on main page of the module. The location of button is shown below. You should click on the button corresponding to the team you want to edit.
After clicking on this button, you’ll be redirected to the page given below.
The data will already be entered there of the team. You just need to make the changes and save it. Changes would be reflected there and saved.
3.2.3 Viewing Team History
To view team history, click on the “History” button provided against each team.
After clicking, you’ll be redirected to page below. It’s just a view page so nothing would be edited here. This page shows the history of the team, who were the teamleads in this team and what was their tenure.
3.3 Member
3.3.1 Add Member
To add a member to a team, click on “Add Member” corresponding to that team.
After clicking it, you’ll be redirected to a page to enter details of team member. Click on “Add” to add member. The same form will be there for you to enter other members.
To see the members that you’ve just added, go to the main page again and you’d see the count of members equivalent to the members you added.
Click on the number to view the members. By clicking, you’d see the list of members in that team. Below is an image to show what exactly you’ll se
3.3.2 Editing Member
To edit a member, click on the edit button while viewing the list of members.
The page will redirect you to the form similar to the page you were taken to for adding member but this time with form pre-filled with the data of member. After editing, click on “Edit” to save the changes. The page remains there though to make further changes if something was left or something was mistakenly changed.
3.3.3 Viewing Member History
You can make this member the team lead or transfer it to another team. Also, you can view history of this member that since when it’s in this team. Below image shows the history of member.
3.4 Making a Teamlead
There are two options to make a team lead which are as follows:
- Selecting the checkbox of “Is teamlead” while creating a new member.
- Making a teamlead while going through the list of members and choosing from there.
In the image above, the Is Team Lead check is enabled which makes this person the teamlead of this particular team and makes member at this time too.
The second option is illustrated below.
In the image above, you can see an option of making new team lead by clicking on “Make New TeamLead”. After clicking on it, an alert would pop up which would ask about the surety of this decision. If you are sure, click on “Ok” to proceed with the decision. Then you would see the same page but now the “Make New TeamLead” option would be replaced by “Team Lead” against that user. Example of the member is shown below:
You can change a team lead by clicking of “Change TeamLead” option on the module’s main page. You’ll be redirected to the members page and there you can opt for new teamlead by clicking of “Make New TeamLead” against the member.
3.5 Transferring a member
Transferring a member is very easy in this module. Just go to the list of the members, click on the Transfer option given against each member. You’ll be redirected to the page where all the teams list would be displayed. Select the team you want to place the member in. The steps in images are shown below.
Select the team.
Member voided from current team. Although the record is shown here but it won’t be counted in the team member count at main page and it will be voided.
Important Note: Once clicked on the “Transfer” option, the member would be voided immediately and then you must have to select a new team for it. So please be firm about your decision. If you’ve done it by mistake, transfer the member to any team and then transfer that member again to current team. There’s no other way at the moment.
3.6 Viewing All Members
There are two ways to view all members defined below:
- By clicking on “View Members” on Administration page.
- By clicking on “View All Members” on module’s main page.
In the image above, click on “View Members” to go to the list of all members.
For the second method, the image is shown below:
Clicking on any of these, will redirect you to the page shown below:
3.7 Search option
This module provides search of team and member for the easiness of the user to find the record in huge list.
3.7.1 Searching a team
At the main page of the module, there is a search option visible. It allows you to search a team via name or id (identifier). It’s ok if you don’t remember the full name of the team or full id. If you remember partial of either, it would bring all the teams matching the criteria.
The image above shows the position of search option.
3.7.2 Searching a member
When navigated to the member list page, you would find a huge list of members there and to search for a single record would be painful. To ease the users from this, the search option is provided there too. A member can be search via name and id (identifier). Also, member can be searched by the date range too like if someone wants to know how many or which members were added between a specific date range.
The image above shows the position of search option at the member list page.
3.8 REST Calls
3.8.1 Team URLs
url | description |
|---|---|
GET openmrs/ws/rest/v1/teammodule/team/{uuid} | Fetch the team that matches the uuid |
GET openmrs/ws/rest/v1/teammodule/team?q={name}&v=full | Fetch the member that matches the parameter |
3.8.2 Representation
GET full |
|---|
display teamId teamIdentifier teamName uuid dateCreated location memberCount resourceVersion |
3.8.3 Member URLs
url | description |
|---|---|
GET openmrs/ws/rest/v1/teammodule/member/{uuid} | Fetch the member that matches the uuid |
GET openmrs/ws/rest/v1/teammodule/member?q={name}&v=full | Fetch the member that matches the parameter |
3.8.4 Representation
GET full |
|---|
teamMemberId identifier isTeamLead person uuid location team resourceVersion |
3.8.5 TeamLead URLs
url | description |
|---|---|
GET openmrs/ws/rest/v1/teammodule/lead/{uuid} | Fetch the team lead that matches the uuid |
3.8.6 Representation
...
GET full
teamLeadId
team
teamMember
uuid
...
Required downloads
- OpenMRS Modules
- OpenMRS UI Framework
- Rest Web Services