You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+91-62
Original file line number
Diff line number
Diff line change
@@ -25,59 +25,88 @@ FormShare **is for organizations** to install it in their server or cloud servic
25
25
26
26
## Features
27
27
28
-
**Current features**
29
-
30
-
- Case management (Longitudinal data collection) (Version >= 2.8.0)
31
-
- Using the Official ODK Collect App
32
-
- Intelligent work flow using Official ODK standards:
33
-
- Case creator forms will create cases.
34
-
- Follow-up forms will attach information to each case.
35
-
- Deactivate forms will deactivate cases. For example, a household that decides to exit a longitudinal study will not appear in follow-up forms after deactivation.
36
-
- Activate forms will activate cases again. For example, a household that decides to re-enter a longitudinal study will appear again in follow-up forms after activation.
37
-
- Move information from case creator forms into follow-up, deactivation and activation forms. For example, the sex of a participant (e. g., female) could be used in follow-up case forms to ask specific questions according to sex (e. g., if female, do they have access to reproductive health services since our last visit?)
38
-
- Support multiple time zones:
39
-
- FormShare's: This is the time zone of the Linux server running FormShare.
40
-
- User: This is the time zone of a user logged into FormShare.
41
-
- Project: Each project can have a different time zone. This should be the time zone where submissions happen.
42
-
- Assistant: This is the time zone of an assistant logged into FormShare.
43
-
- Partner: This is the time zone of a partner logged into FormShare.
44
-
45
-
- User accounts and management
46
-
- Group-based user permissions
47
-
- Projects to organize users, permissions, and forms
48
-
- Separate access for data collectors and data cleaners. This is useful when dealing with hundreds of data collectors that do not need a FormShare user access
49
-
- Separate access for partners: Partners are trusted individuals outside your organization that require access to products and other resources in FormShare to collaborate with you. For example, a professor at a university (a partner in your project) requiring a KML export to match GPS points with weather data.
50
-
- User collaborations at project level, e.g., you can allow a colleague to maintain certain aspects of your project.
51
-
- Form and submission management
52
-
- With easy setup of ODK Collect Projects using QR images
53
-
- With support for form version updates
54
-
- With testing and production stages
55
-
- Showing structural changes between incremental versions.
56
-
- With form and submission multimedia or data attachments
57
-
- With a table preview of submission data (even with thousand or millions of records) allowing in-table edits and recording any changes made to the data
58
-
- OData live data feed for analysis with tools like Excel and Power BI. **With all CRUD operation supported (e. g., update)**. You can even use [Excel](https://github.com/qlands/MrBot-OData-Add-In) to clean data.
59
-
- Extensibility system, e.g., You can write extensions to connect FormShare with Microsoft 365 authentication system
60
-
- Documentation for running on AWS using Docker
61
-
- Data cleaning API integration with R, STATA, or SPSS
62
-
- Real-time map visualization of geo-referenced submissions at project and form level
63
-
- Fill out forms using the web browser through [Enketo](https://github.com/qlands/formshare_enketo_plugin)
64
-
- Download form attachments
65
-
- Filtering submissions by submission metadata (e.g., date and time received on server)
66
-
- Parse submissions into database tables. FormShare will create a MySQL data repository to store your data
67
-
- The repository is controlled with a primary key e.g., Farmed ID
68
-
- Duplicated submissions go to a cleaning pipe-line system that makes it easier to compare submissions and decide what to do with the duplicates
69
-
- Private and publishable data downloads in Excel and CSV formats
70
-
- Mark data fields as sensitive to exclude them from publishable products
71
-
- Version control on products, e.g., FormShare will let you know if a data export does not have the latest submissions or changes in the database
72
-
- Make publishable products publicly available knowing that sensitive fields are excluded automatically
73
-
- Download geo-referenced information in KML format
74
-
75
-
**Short-term features:**
76
-
77
-
- Graph visualization with dashboards.
78
-
- Connecting data fields with ontological variables. This is useful when comparing variables across studies even if variable names are different
79
-
- Real-time data aggregation (pull data from different forms into one common data bucket). This is useful when dealing with slightly different forms for different geographies but where that certain fields could be aggregated into a common pot for analysis
80
-
- Real-time data cleaning scripts using R
28
+
### Case management (Longitudinal data collection) (Version >= 2.8.0)
29
+
30
+
- Using the Official ODK Collect App.
31
+
- Intelligent workflow using Official ODK standards:
32
+
- Case creator forms will create cases.
33
+
- Follow-up forms will attach information to each case.
34
+
- Deactivate forms will deactivate cases. For example, a household that decides to exit a longitudinal study will not appear in follow-up forms after deactivation.
35
+
- Activate forms will activate cases again. For example, a household that decides to re-enter a longitudinal study will appear again in follow-up forms after activation.
36
+
- Move information from case creator forms into follow-up, deactivation, and activation forms. For example, the sex of a participant (e. g., female) could be used in follow-up case forms to ask specific questions according to sex (e. g., if female, do they have access to reproductive health services since our last visit?)
37
+
38
+
### Support for multiple time zones
39
+
40
+
FormShare can produce dates and times in the following time zones:
41
+
42
+
- FormShare: This is the time zone of the Linux server running FormShare.
43
+
- User: This is the time zone of a user logged into FormShare.
44
+
- Project: Each project can have a different time zone. This should be the time zone where submissions happen.
45
+
- Assistant: This is the time zone of an assistant logged into FormShare.
46
+
- Partner: This is the time zone of a partner logged into FormShare.
47
+
48
+
### User and project management
49
+
50
+
- User accounts and management.
51
+
- Group-based user permissions.
52
+
- Projects to organize users, permissions, and forms.
53
+
- Separate access for data collectors and data cleaners. This is useful when dealing with hundreds of data collectors that do not need a FormShare user's account.
54
+
- Separate access for partners: Partners are trusted individuals outside your organization that require access to products and other resources in FormShare to collaborate with you. For example, a professor at a university (a partner in your project) requires a KML export to match GPS points with weather data.
55
+
- User collaborations at a project level, e.g., you can allow a colleague to maintain certain aspects of your project.
56
+
57
+
### Form and submission management
58
+
59
+
- Easy setup of ODK Collect Projects using QR images.
60
+
- Support for form version updates.
61
+
- With testing and production stages.
62
+
- Showing structural changes between incremental versions.
63
+
- With form and submission multimedia or data attachments.
64
+
- Table preview of submission data (even with thousands or millions of records) allowing in-table edits and recording any changes made to the data.
65
+
- Fill out forms using the web browser through [Enketo](https://github.com/qlands/formshare_enketo_plugin).
66
+
- Real-time map visualization of geo-referenced submissions at project and form levels.
67
+
- Download form attachments.
68
+
69
+
### Database management and interoperability
70
+
71
+
- Parse submissions into database tables. FormShare will create a MySQL data repository to store your data.
72
+
- The repository is controlled with a primary key e.g., Farmed ID.
73
+
- Duplicated submissions go to a cleaning pipeline system that makes it easier to compare submissions and decide what to do with the duplicates.
74
+
- Filtering submissions by submission metadata (e.g., date and time received on server).
75
+
- Data cleaning API integration with R, STATA, or SPSS.
76
+
- OData real-time data feed for analysis with tools like Excel and Power BI. **With all CRUD operations supported (e. g., update)**. You can even use [Excel](https://github.com/qlands/MrBot-OData-Add-In) to clean data.
77
+
- Data dictionary with personal information protection.
78
+
79
+
### Product management
80
+
81
+
- Private and publishable data downloads in Excel, CSV, and JSON formats.
82
+
- Publishable products exclude protected fields (personal information protection) automatically.
83
+
- Version control on products, e.g., FormShare will let you know if a data export does not have the latest submissions or changes in the database.
84
+
- Download geo-referenced information in KML format.
85
+
86
+
### Performance, concurrency, and parallelism
87
+
88
+
Though FormShare with the default settings can handle a load that would fit most organizations, it can be configured to handle any load. FormShare has been tested, using [JMeter](https://jmeter.apache.org/), under extreme traffic (1000 parallel submissions ) in an eight years old laptop with 16 GB of RAM and an [i7-4712HQ](https://www.intel.com/content/www/us/en/products/sku/78932/intel-core-i74712hq-processor-6m-cache-up-to-3-30-ghz/specifications.html).
89
+
90
+
- Each submission is transactional. This means that a submission is either processed completely or thoroughly discarded for ODK Collect to re-send it.
91
+
- Under extreme traffic, FormShare can store a complex survey like [RHoMIS](https://www.rhomis.org/) at 18 submissions per second with zero failures.
92
+
- Data exports support concurrent processing. A survey like RHoMIS with 100,000 submissions and millions of rows would take less than a minute to export to JSON or CSV.
93
+
- The performance of the user interface or the data cleaning interface is not affected by the number of submissions.
94
+
95
+
### Analytics
96
+
97
+
- Real-time analytics from R using the [FormShare R Package](https://cran.r-project.org/web/packages/FormShare/index.html).
98
+
- Real-time analytics from platforms like [Tableau](https://public.tableau.com/en-us/s/) and [Power BI](https://powerbi.microsoft.com/en-us/) using the [FormShare OData extension](https://github.com/qlands/formshare_odata_plugin).
99
+
100
+
### Extensibility and others
101
+
102
+
- Extensibility system, e.g., You can write extensions to connect FormShare with Microsoft 365 authentication system. See a list of extensions [below](#Customization-and-Extension).
103
+
- Documentation for running on AWS using Docker.
104
+
105
+
### Future features
106
+
107
+
- Simple graph visualization with dashboards.
108
+
- Connecting data fields with ontological variables. This is useful when comparing variables across studies even if variable names are different.
109
+
- Real-time data aggregation (pull data from different forms into one common data bucket). This is useful when dealing with slightly different forms for different geographies but where that certain fields could be aggregated into a common pot for analysis.
81
110
82
111
ScreenShot
83
112
----------
@@ -86,11 +115,11 @@ ScreenShot
86
115
87
116
Releases
88
117
------------
89
-
The current stable release is 2.23.0 and it is available [here](https://github.com/qlands/FormShare/tree/stable-2.23.0)
118
+
The current stable release is 2.24.0 and it is available [here](https://github.com/qlands/FormShare/tree/stable-2.24.0)
90
119
91
-
The database signature for stable 2.23.0 is e2d6d5aa3700
120
+
The database signature for stable 2.24.0 is e2d6d5aa3700
0 commit comments