Difference between revisions of "TheNeedle"

From NP Tracker projects
Jump to navigation Jump to search
 
(32 intermediate revisions by the same user not shown)
Line 4: Line 4:
 
==Managing People on your deployment==
 
==Managing People on your deployment==
 
===Roles===
 
===Roles===
−
This feature allows you to set up and manage default and custom roles and permissions for different user groups on your deployment. Each deployment has a default “Admin” and "Member" role, which cannot be deleted, but can be edited. The default “Admin” role allows for full control over ALL functionality on your deployment, while the default "Member" role only grants access to edit their own posts.
+
This feature allows you to set up and manage default and custom  
 +
roles and permissions for different user groups on your deployment. Each deployment has a default “Admin” and "Member" role, which cannot be deleted, but can be edited. The default “Admin” role allows for full control over ALL functionality on your deployment, while the default "Member" role only grants access to edit their own posts.
 
====Setup Guide====
 
====Setup Guide====
 
To access the roles management page,
 
To access the roles management page,
−
* On the left hand menu bar, click on Settings
+
* On the left hand menu bar, click on '''Settings'''
−
* Then, click on Roles
+
[[File:TheNeedle1.png|400px|thumb|center|Settings button on the TheNeedle Platform sidebar]]<br>
 +
* Then, click on '''Roles'''
 +
[[File:TheNeedle2.png|400px|thumb|center|Settings list page. Roles button highlighted]]<br>
 
* You’ll be redirected to a page with a list of all existing roles - default & custom roles (created by admins if any exist).
 
* You’ll be redirected to a page with a list of all existing roles - default & custom roles (created by admins if any exist).
 
=====Add Role=====
 
=====Add Role=====
 
To add a custom user role,
 
To add a custom user role,
−
* Click on the yellow Add icon
+
* Click on the yellow '''Add icon'''
 +
[[File:TheNeedle3.png|400px|thumb|center|Settings list page. Roles button highlighted]]<br>
 
* Add the following details
 
* Add the following details
−
** Name: Provide a name for this new custom role
+
** '''Name''': Provide a name for this new custom role
−
** Description: Provide a brief description of what/who this custom role has been created for
+
** '''Description''': Provide a brief description of what/who this custom role has been created for
−
** Set your permissions. Below is a brief breakdown of what permissions get granted to users on selecting the options provided.
+
** '''Set your permissions'''. Below is a brief breakdown of what permissions get granted to users on selecting the options provided.
−
*** Manage Users: Allows for;
+
*** '''Manage Users''': Allows for;
 
**** Viewing Users
 
**** Viewing Users
 
**** Adding, Editing, Deleting Users
 
**** Adding, Editing, Deleting Users
 
**** and Changing roles for Users
 
**** and Changing roles for Users
−
*** Manage Posts: Allows for;
+
*** '''Manage Posts''': Allows for;
 
**** Viewing posts
 
**** Viewing posts
 
**** Editing and Deleting Posts
 
**** Editing and Deleting Posts
Line 27: Line 31:
 
**** Adding posts to collections
 
**** Adding posts to collections
 
**** Creating new collections
 
**** Creating new collections
−
*** Manage Settings: Allows for managing;
+
*** '''Manage Settings''': Allows for managing;
 
**** General Settings
 
**** General Settings
 
**** Map Settings
 
**** Map Settings
Line 33: Line 37:
 
**** Surveys
 
**** Surveys
 
**** Categories
 
**** Categories
−
*** Bulk Data import and Export: Allows for upload of data via CSV files and exporting files.
+
*** '''Bulk Data import and Export''': Allows for upload of data via CSV files and exporting files.
−
*** Edit their own posts: Allows for editing of posts submitted by user
+
*** '''Edit their own posts''': Allows for editing of posts submitted by user
−
*** Manage collections and saved searches: Allows for
+
*** '''Manage collections and saved searches''': Allows for
 
**** Addition posts to all saved searches/collections on
 
**** Addition posts to all saved searches/collections on
 
**** Removing posts from all saved searches/collections
 
**** Removing posts from all saved searches/collections
 
**** Editing all saved searches/collections
 
**** Editing all saved searches/collections
 
**** Deleting all saved searches/collections
 
**** Deleting all saved searches/collections
−
** Click on Save.
+
** Click on '''Save'''.
 +
[[File:TheNeedle4.png|400px|thumb|center|The add role page contains a role name, description, and preferred permissions.]]<br>
 
=====Edit Role=====
 
=====Edit Role=====
 
To edit a role
 
To edit a role
 
* Click on a role from the list provided to you.
 
* Click on a role from the list provided to you.
 +
[[File:TheNeedle5.png|400px|thumb|center|Click on a role from the Role.]]<br>
 
* On redirection to the edit page, make your desired changes to the role (i.e fill out details as directed in the Add role section)
 
* On redirection to the edit page, make your desired changes to the role (i.e fill out details as directed in the Add role section)
−
* Click on Save to update the role.
+
* Click on '''Save''' to update the role.
 +
[[File:TheNeedle6.png|400px|thumb|center|Adding details to a new role. Name, description and permission fields available.]]<br>
 
=====Delete Role=====
 
=====Delete Role=====
 
* To delete a role
 
* To delete a role
 
* Click on a role from the Roles management list page
 
* Click on a role from the Roles management list page
−
* Then, click on the Delete This Role button at the bottom of the page
+
[[File:TheNeedle7.png|400px|thumb|center|Selecting a role in the roles list.]]<br>
 +
* Then, click on the '''Delete This Role''' button at the bottom of the page
 +
[[File:TheNeedle8.png|400px|thumb|center|Click the DELETE THIS ROLE button.]]<br>
 
* A pop up box will appear on the top of the page, prompting you to confirm whether you would like to delete the custom role. If
 
* A pop up box will appear on the top of the page, prompting you to confirm whether you would like to delete the custom role. If
−
** You would like to proceed with deletion, click on Delete
+
** You would like to proceed with deletion, click on '''Delete'''
−
** You would not like to proceed with deletion, click on Cancel
+
** You would not like to proceed with deletion, click on '''Cancel'''
 +
[[File:TheNeedle9.png|400px|thumb|center|Delete role confirmation  pop up.]]<br>
 +
 
 
===Users===
 
===Users===
 
====Setup guide====
 
====Setup guide====
 
To access the User management page,
 
To access the User management page,
−
* On the left hand menu bar, click on Settings
+
* On the left hand menu bar, click on '''Settings'''
−
* Then, click on Users.
+
[[File:TheNeedle1.png|400px|thumb|center|Settings button on the TheNeedle Platform sidebar]]<br>
 +
* Then, click on '''Users'''.
 +
[[File:TheNeedle10.png|400px|thumb|center|Settings -> Users]]<br>
 
* You’ll be redirected to a page with a list of all existing users on your deployment
 
* You’ll be redirected to a page with a list of all existing users on your deployment
 
* From here, you can search for users either by name or by custom role
 
* From here, you can search for users either by name or by custom role
 +
[[File:TheNeedle11.png|400px|thumb|center|]]<br>
 +
[[File:TheNeedle12.png|400px|thumb|center|]]<br>
 
=====Adding new users=====
 
=====Adding new users=====
 
To add a new user,
 
To add a new user,
−
* Click on the yellow icon as shown below
+
* Click on the '''yellow icon''' as shown below
 +
[[File:TheNeedle13.png|400px|thumb|center|]]<br>
 
* Fill out the details below
 
* Fill out the details below
−
** Display Name: This is the name that will be displayed
+
** '''Display Name''': This is the name that will be displayed
−
** Email address: This is the email address that will be tied to this new user’s account, and will be used to log in.
+
** '''Email address''': This is the email address that will be tied to this new user’s account, and will be used to log in.
−
** Password: Set a strong and secure password for your new user. Each password must have at least 7 characters
+
** '''Password''': Set a strong and secure password for your new user. Each password must have at least 7 characters
−
** Role: Choose the level of administration access you would like this user to have
+
** '''Role''': Choose the level of administration access you would like this user to have
−
*Click on Save to create one.
+
* Click on '''Save''' to create one.
 +
[[File:TheNeedle14.png|400px|thumb|center|]]<br>
 
=====Editing users=====
 
=====Editing users=====
 
To edit a user,
 
To edit a user,
 
* Click on the user you intend to edit from the user list page
 
* Click on the user you intend to edit from the user list page
 +
[[File:TheNeedle15.png|400px|thumb|center|]]<br>
 
* You should be able to edit the user’s display name, email address, password and user role from this page.
 
* You should be able to edit the user’s display name, email address, password and user role from this page.
−
* Click on save when done.
+
[[File:TheNeedle16.png|400px|thumb|center|]]<br>
 +
* Click on '''Save''' when done.
 
=====Changing User roles=====
 
=====Changing User roles=====
 
You can change multiple users’ roles at once from the user management page.
 
You can change multiple users’ roles at once from the user management page.
 
* Tick the checkbox on the left, adjacent to the user(s) whose role you would like to change from the user list page
 
* Tick the checkbox on the left, adjacent to the user(s) whose role you would like to change from the user list page
−
* This action will activate the previously inactive Change Role dropdown button on the top menu bar.
+
* This action will activate the previously inactive '''Change Role''' dropdown button on the top menu bar.
 +
[[File:TheNeedle17.png|400px|thumb|center|]]<br>
 
* Click on this dropdown and select the role you would like to assign your users to.
 
* Click on this dropdown and select the role you would like to assign your users to.
 +
[[File:TheNeedle18.png|400px|thumb|center|]]<br>
 
* A pop up box will appear, prompting you to confirm whether you would like to change the roles of your user(s)
 
* A pop up box will appear, prompting you to confirm whether you would like to change the roles of your user(s)
−
** Click on OK to change your user(s) role
+
** Click on '''OK''' to change your user(s) role
−
** If you’d like to cancel the role change process, click on Cancel.
+
** If you’d like to cancel the role change process, click on '''Cancel'''.
 +
[[File:TheNeedle19.png|400px|thumb|center|]]<br>
 
=====Deleting users=====
 
=====Deleting users=====
 
Similarly, you can delete multiple users at once from the user management page, or from the individual user edit page.<br>
 
Similarly, you can delete multiple users at once from the user management page, or from the individual user edit page.<br>
Line 87: Line 109:
 
* From the individual user edit page
 
* From the individual user edit page
 
** Click on the user you intend to edit from the user list page.
 
** Click on the user you intend to edit from the user list page.
−
** Click on Delete User.
+
[[File:TheNeedle20.png|400px|thumb|center|]]<br>
 +
** Click on '''Delete User'''.
 +
[[File:TheNeedle21.png|400px|thumb|center|]]<br>
 
** A pop up box will appear on the top of the page, prompting you to confirm whether you would like to delete your user
 
** A pop up box will appear on the top of the page, prompting you to confirm whether you would like to delete your user
−
*** Click on Delete to delete your user
+
*** Click on '''Delete''' to delete your user
−
*** If you’d like to cancel the user deletion process, click on Cancel.
+
*** If you’d like to cancel the user deletion process, click on '''Cancel'''.
 +
[[File:TheNeedle22.png|400px|thumb|center|]]<br>
 
** From the User management page
 
** From the User management page
 
*** Tick the checkbox on the left, adjacent to the user(s) you would like to delete from the user list page
 
*** Tick the checkbox on the left, adjacent to the user(s) you would like to delete from the user list page
−
*** This action will activate the previously inactive Delete button on the top menu bar. Click on it to initiate the deletion process.
+
*** This action will activate the previously inactive '''Delete''' button on the top menu bar. Click on it to initiate the deletion process.
 +
[[File:TheNeedle23.png|400px|thumb|center|]]<br>
 
*** A pop up box will appear, prompting you to confirm whether you would like to delete your user(s)
 
*** A pop up box will appear, prompting you to confirm whether you would like to delete your user(s)
−
**** Click on DELETE to delete your user(s)
+
**** Click on '''Delete''' to delete your user(s)
−
**** If you’d like to cancel the user deletion process, click on Cancel.
+
**** If you’d like to cancel the user deletion process, click on '''Cancel'''.
 +
[[File:TheNeedle24.png|400px|thumb|center|]]<br>
 +
 
 
==Modes for visualizing and managing data on your deployment==
 
==Modes for visualizing and managing data on your deployment==
 
TheNeedle platform provides you with modes to not only visualise your data in different ways, but to also manage it.<br>
 
TheNeedle platform provides you with modes to not only visualise your data in different ways, but to also manage it.<br>
Line 104: Line 132:
 
* Data view
 
* Data view
 
* Activity view
 
* Activity view
 +
* Then, click on '''Users'''.
 +
[[File:TheNeedle25.png|400px|thumb|center|Logged out version of the sidebar of an TheNeedle deployment.]]<br>
 
Signed in users(with the necessary permissions) can access four different modes as shown below:-
 
Signed in users(with the necessary permissions) can access four different modes as shown below:-
 
* Map view
 
* Map view
Line 109: Line 139:
 
* Activity view
 
* Activity view
 
* Settings page
 
* Settings page
 +
[[File:TheNeedle26.png|400px|thumb|center|Logged in version of the sidebar of an TheNeedle deployment.]]<br>
 
Your TheNeedle deployment defaults to the map mode for anyone who visits your homepage(as illustrated above). To change your current mode, select any of the options provided to you from the menu on your left.
 
Your TheNeedle deployment defaults to the map mode for anyone who visits your homepage(as illustrated above). To change your current mode, select any of the options provided to you from the menu on your left.
 
===Map View===
 
===Map View===
 
This mode displays all published posts on a map.
 
This mode displays all published posts on a map.
−
* Each post appears as an icon on the map. In the event that you opted to combine nearby posts on your Map settings page, posts adjacent to each other on the map will cluster together, displaying a number denoting number of posts combined.
+
* Each post appears as an icon on the map. In the event that you opted to combine nearby posts on your Map settings page, posts adjacent to each other on the map will cluster together, displaying a number denoting number of posts combined.
−
* Clicking on each individual post displays a small pop up box with the post title and description.
+
* Clicking on each individual post displays a small pop up box with the '''post title''' and '''description'''.
 
* You should also be able to zoom in and out of the map as desired.
 
* You should also be able to zoom in and out of the map as desired.
 +
[[File:TheNeedle27.jpg|400px|thumb|center|Example of the Uchaguzi deployment with the map view.]]<br>
 
You also get a breakdown of incoming posts by source, as shown below.
 
You also get a breakdown of incoming posts by source, as shown below.
 +
[[File:TheNeedle28.png|400px|thumb|center|The map view sidebar allows you to filter out Data sources.]]<br>
 
===Data View===
 
===Data View===
 
The Data view allows you to view, triage, and manage posts coming into your deployment as a chronological list of events over time. It provides a split pane that lists post summaries on the left pane, and post details and editing features in the right.<br>
 
The Data view allows you to view, triage, and manage posts coming into your deployment as a chronological list of events over time. It provides a split pane that lists post summaries on the left pane, and post details and editing features in the right.<br>
 +
[[File:TheNeedle30.png|400px|thumb|center|A list of posts on the left side of the data view. Click on one to select it.]]<br>
 
From here, you should be able to:
 
From here, you should be able to:
 
* Add new posts
 
* Add new posts
 +
[[File:TheNeedle31.png|400px|thumb|center|Adding new posts via the yellow + circle button.]]<br>
 
* View individual post details
 
* View individual post details
 
* Edit posts to either change existing structures or assign posts from Twitter, SMS and/or email to a survey
 
* Edit posts to either change existing structures or assign posts from Twitter, SMS and/or email to a survey
 +
[[File:TheNeedle32.png|400px|thumb|center|]]<br>
 
* You can also
 
* You can also
 
** Add posts to collections
 
** Add posts to collections
Line 129: Line 165:
 
** Share posts
 
** Share posts
 
** Delete posts
 
** Delete posts
 +
[[File:TheNeedle33.png|400px|thumb|center|Click on the "..." button on a post to see a list of actions.]]<br>
 +
[[File:TheNeedle34.png|400px|thumb|center|Listed actions: edit, add to collection, share, publish, put under review, archive, delete.]]<br>
 
* Get notified when new posts arrive
 
* Get notified when new posts arrive
 +
[[File:TheNeedle35.png|400px|thumb|center|Click on the "..." button on a post to see a list of actions.]]<br>
 
* Perform bulk actions( publishing, putting under review, archiving, adding to collections and deleting) on multiple posts at a time
 
* Perform bulk actions( publishing, putting under review, archiving, adding to collections and deleting) on multiple posts at a time
 +
[[File:TheNeedle36.png|400px|thumb|center|Highlighted: bulk actions button.]]<br>
 +
[[File:TheNeedle37.png|400px|thumb|center|Highlighted: bulk actions. Publish, Put under review, Archive.]]<br>
 
NB: Data displayed on this page is dependent on permissions granted to the user viewing this page
 
NB: Data displayed on this page is dependent on permissions granted to the user viewing this page
 +
 
===Activity View===
 
===Activity View===
 
This mode gives you a summary of how people are interacting with your deployment over time.<br>
 
This mode gives you a summary of how people are interacting with your deployment over time.<br>
 +
[[File:TheNeedle40.png|400px|thumb|center|Highlighted: select time frame button.]]<br>
 +
[[File:TheNeedle41.png|400px|thumb|center|Highlighted: time filters.]]<br>
 
You can compare
 
You can compare
−
* Activity over time
+
* '''Activity over time'''
 +
[[File:TheNeedle42.png|400px|thumb|center|Activity over time. Select "Compare" dropdown to get different types of activity data.]]<br>
 
You can filter post count in a line chart over time by:-
 
You can filter post count in a line chart over time by:-
−
* All posts
+
* '''All posts'''
−
* Categories that the posts belong to
+
* '''Categories''' that the posts belong to
−
* Surveys that the posts were submitted to
+
* '''Surveys''' that the posts were submitted to
−
* Status i.e whether they’re published or not
+
* '''Status''' i.e whether they’re published or not
 +
[[File:TheNeedle43.png|400px|thumb|center|Highlighted: compare options. All posts, categories, surveys, statuses.]]<br>
 
You can opt to view your post counts on the graph as cumulative totals.
 
You can opt to view your post counts on the graph as cumulative totals.
−
* Activity by Volume
+
* '''Activity by Volume'''
 +
[[File:TheNeedle44.png|400px|thumb|center|Highlighted: comparison type dropdown. "Categories" option selected.]]<br>
 
* You can filter post count in a bar chart by volume by:-
 
* You can filter post count in a bar chart by volume by:-
−
** Categories that the posts belong to
+
** '''Categories''' that the posts belong to
−
** Surveys that the posts were submitted to
+
** '''Surveys''' that the posts were submitted to
−
** Status i.e whether they’re published or not
+
** '''Status''' i.e whether they’re published or not
 +
[[File:TheNeedle45.png|400px|thumb|center|Highlighted: comparison type dropdown. "Categories" option selected. Other options: survey and status.]]<br>
 +
 
 
==Managing Data in your deployment==
 
==Managing Data in your deployment==
 
A post is a report of a single instance of something in the deployment. It can be made up of many fields, such as Title, Description, Date, Links, and/or location. TheNeedle allows for collection of posts via
 
A post is a report of a single instance of something in the deployment. It can be made up of many fields, such as Title, Description, Date, Links, and/or location. TheNeedle allows for collection of posts via
Line 154: Line 203:
 
====Viewing Posts====
 
====Viewing Posts====
 
Posts on your deployment can be categorised into two types of data:-
 
Posts on your deployment can be categorised into two types of data:-
−
* Structured: Incoming posts from the web platform and smartphone applications are classified as structured posts, since they adhere to  the structure of surveys created on your deployment.
+
* '''Structured''': Incoming posts from the web platform and smartphone applications are classified as structured posts, since they adhere to  the structure of surveys created on your deployment.
−
* Unstructured/Unknown: Incoming messages from SMS, Twitter and Email are classified as unknown posts, since they do not adhere to the structure of surveys created on your deployment. This means that these messages come in their raw form, and have to be manually structured by admins/anyone with permissions to edit posts, to fit into the structure of your survey. E.g an SMS message “Hello, my name is Angela” will need to be broken down into a title, a description, properly categorised etc.
+
* '''Unstructured/Unknown''': Incoming messages from SMS, Twitter and Email are classified as unknown posts, since they do not adhere to the structure of surveys created on your deployment. This means that these messages come in their raw form, and have to be manually structured by admins/anyone with permissions to edit posts, to fit into the structure of your survey. E.g an SMS message “Hello, my name is Angela” will need to be broken down into a title, a description, properly categorised etc.
 
You can view posts in either Map, Data or Activity mode. We'd previously discussed each of these modes separately in Chapter 5.<br>
 
You can view posts in either Map, Data or Activity mode. We'd previously discussed each of these modes separately in Chapter 5.<br>
 +
[[File:TheNeedle46.png|400px|thumb|center|]]<br>
 
For purposes of managing your data, we recommend using Data Mode. From this page, You should be able to see the following:-
 
For purposes of managing your data, we recommend using Data Mode. From this page, You should be able to see the following:-
 
* A list of all posts in chronological order of when they were submitted into the platform. You can opt to change the order of the posts either through options provided in the search filter ( we'll dive into filtering posts in the next section )
 
* A list of all posts in chronological order of when they were submitted into the platform. You can opt to change the order of the posts either through options provided in the search filter ( we'll dive into filtering posts in the next section )
−
* Post visibility Status: You can tell if a post is public or only visible to a specific audience
+
* '''Post visibility Status''': You can tell if a post is public or only visible to a specific audience
−
* Post source (is it from the NPS-OSINT or another source?).
+
* '''Post source''' (is it from the NPS-OSINT or another source?).
−
* Structured posts via web/smartphones will have their respective source label on them.
+
[[File:TheNeedle47.png|400px|thumb|center|]]<br>
−
* Unstructured posts will have a label denoting their source, as seen below with this sample NPS-OSINT message
+
* '''Structured posts''' via web/smartphones will have their respective source label on them.
−
* When the post was submitted: Hovering over the timestamp of the post will give additional details on specific timing as shown below.
+
* '''Unstructured posts''' will have a label denoting their source, as seen below with this sample NPS-OSINT message
−
* Individual Post descriptions on the left pane, and post details _on selection of a post card on the right pane
+
[[File:TheNeedle48.png|400px|thumb|center|]]<br>
 +
* '''When the post was submitted''': Hovering over the timestamp of the post will give additional details on specific timing as shown below.
 +
[[File:TheNeedle49.png|400px|thumb|center|]]<br>
 +
* Individual '''Post descriptions''' on the left pane, '''and post details''' on selection of a post card on the right pane
 +
[[File:TheNeedle50.png|400px|thumb|center|]]<br>
 
* When viewing post details on the right pane, you'll be able to see additional details such as location, categories, and tasks.
 
* When viewing post details on the right pane, you'll be able to see additional details such as location, categories, and tasks.
−
* If you’re an admin/your user role permits, you’ll should also be able to see the Edit button on the top right hand corner of your page
+
[[File:TheNeedle51.png|400px|thumb|center|]]<br>
 +
* If you’re an admin/your user role permits, you’ll should also be able to see the Edit button on the top right-hand corner of your page
 +
[[File:TheNeedle52.png|400px|thumb|center|]]<br>
 +
'''NB: Locked posts - The platform allows for post locking, to avoid duplication of efforts. If someone on your team is currently editing a post, it is locked and made unavailable for you to edit. In this case, the edit button will not be visible to you, despite having adequate permissions.'''
 +
* Every post has a three-dotted icon as shown below. Depending on what permissions are granted to the person viewing, this button allows you to
 +
** '''Add your post to a collection''' (public)
 +
** '''Share this post''' (public) via facebook, twitter, embed on another website or export it to a CSV file.
 +
** '''Edit your post''' (limited by role)
 +
** '''Publish your post''' (limited by role)
 +
** '''Put your post under review''', setting visibility to only members of your team (limited by role)
 +
** '''Archive your post''' (limited by role)
 +
** '''Delete your post''' (limited by role)
 +
[[File:TheNeedle53.png|400px|thumb|center|]]<br>
 +
[[File:TheNeedle54.png|400px|thumb|center|]]<br>
 +
* A '''search filter''' that allows you to
 +
** sort posts by
 +
*** Date of creation
 +
*** Post date i.e date when it was assigned to a survey
 +
*** Date updated
 +
** filter reports by '''Saved searches, Status, Surveys, Categories, Data source, Date range, Location''' or any other user determined parameters.
 +
[[File:TheNeedle55.png|400px|thumb|center|]]<br>
 +
[[File:TheNeedle56.png|400px|thumb|center|]]<br>
  
−
NB: Locked posts - The platform allows for post locking, to avoid duplication of efforts. If someone on your team is currently editing a post, it is locked and made unavailable for you to edit. In this case, the edit button will not be visible to you, despite having adequate permissions. We'll dive deeper into post locking in section 6.4.2 of this manual.
+
Please note that information displayed to users on each of these pages is dependent on permissions granted to registered/non registered users by the deployment administrator e.g '''Published posts''', '''Unknown posts''' and '''My posts''', and menu bars allowing for editing and deletion are only visible to logged in users with necessary granted permissions.
−
Every post has a three dotted icon as shown below. Depending on what permissions are granted to the person viewing, this button allows you to
+
====Filtering Posts====
−
Add your post to a collection (public)
+
Filters can be applied to narrow down a large amount of data. You can filter posts by many types of parameters, for example: '''Surveys, Categories, Status, Date Ranges, and Location'''.<br>
−
Share this post (public) via facebook, twitter, embed on another website or export it to a CSV file.
+
Survey and Category filters are located within the "Filters" modal on the top global search bar, which allows you to
−
Edit your post (limited by role)
+
* '''sort posts by'''
−
Publish your post (limited by role)
+
** Date of creation
−
Put your post under review, setting visibility to only members of your team (limited by role)
+
** Post date i.e date when it was assigned to a survey
−
Archive your post (limited by role)
+
** Date updated
−
Delete your post (limited by role)
+
* '''filter reports by'''
 +
** '''Saved searches'''
 +
*** By default, every deployment has a set of three featured Saved Searches(read more in the Saved Searches section of this manual) from which you can view posts on your deployment, from the search filter.These include:-
 +
**** '''Published Posts''': Lists all posts that have been made public on your deployment(i.e can be viewed by registered/non-registered users on your deployment.
 +
**** '''Unknown Posts''': Lists all messages received from SMS, Email and Twitter, that have not been assigned to a survey i.e are unstructured
 +
**** '''My posts''': Lists all posts created by you as a user
 +
** '''Status'''
 +
*** Published: Posts that can be seen by both logged in and non logged in users
 +
*** Under review: Posts that can only be seen by logged in users with adequate permissions
 +
*** Archived: Posts that have been deemed to be irrelevant and removed from your active view
 +
** Other filters include '''Surveys, Categories, Data source, Date range, Location''' or any other user determined parameters
 +
[[File:TheNeedle55.png|400px|thumb|center|]]<br>
 +
[[File:TheNeedle56.png|400px|thumb|center|]]<br>
 +
Filters are additive, so you can apply as many as you would like. This search filter is available on all pages.
  
−
A search filter that allows you to
+
====Adding Posts====
−
sort posts by
+
Directly from the NPS-OSINT
−
Date of creation
+
Registered users can create posts using the same process described below. For descriptive purposes, the post below has one tasks.
−
Post date i.e date when it was assigned to a survey
+
To create a post,
−
Date updated
+
* Click on the yellow add icon as shown below on your homepage, or on the bottom left corner on the data mode page
 +
[[File:TheNeedle59.png|400px|thumb|center|]]<br>
 +
* In the event that you have multiple surveys on your deployment, you’ll have to choose the survey from a list of all surveys available on your deployment.
 +
[[File:TheNeedle60.png|400px|thumb|center|]]<br>
 +
* At the upper left corner of the page, click on the dropdown menu and see the available languages that the survey form can be viewed in, click on the language you prefer and fill the form in the chosen language.
 +
* Make sure to fill out all fields with a red asterisk beside them, You will not be able to save or publish your post before these fields are filled out.
 +
** NB: Users are now able to submit improvements to the OpenStreetMap Basemap, directly from the post submission page. In some cases, base maps are not up to date. We highly encourage you to contribute to improving base maps in your locations of interest. For more details on how to improve OpenStreetMap, visit the [https://wiki.openstreetmap.org/wiki/Beginners_guide| OSM wiki here].
 +
* Make sure to fill out any tasks visible to you on this submission page as well. NB: You can submit posts without filling out or completing tasks. However, in the event that your task is a requirement for publishing, this post will not be published unless the task is marked as complete.
 +
* When you’re done adding content for your post, click on '''Submit'''.
 +
[[File:TheNeedle61.png|400px|thumb|center|]]<br>
 +
* Your post will be submitted to the deployment’s admin for review before publishing.
  
−
filter reports by Saved searches, Status, Surveys, Categories, Data source, Date range, Location or any other user determined parameters. More on filters in section 6.2
+
====Editing Posts====
 +
The post editing function is only available to admins or registered users with adequate permissions. This means that non registered users cannot edit posts.<br>
 +
This feature is particularly useful when creating posts out of '''unstructured posts''' (messages from SMS, Email, Twitter).<br>
 +
To edit a post,
 +
* Select a post from your data view
 +
[[File:TheNeedle62.png|400px|thumb|center|]]<br>
 +
[[File:TheNeedle63.png|400px|thumb|center|]]<br>
 +
* Click on '''Edit'''. This will load the post editor on the right pane of your page, where you’ll be able to edit any of the content.
 +
[[File:TheNeedle64.png|400px|thumb|center|]]<br>
 +
[[File:TheNeedle65.png|400px|thumb|center|]]<br>
 +
[[File:TheNeedle66.png|400px|thumb|center|]]<br>
 +
* If you're logged in and have adequate permissions you should also be able to change the status of your post.
 +
[[File:TheNeedle67.png|400px|thumb|center|]]<br>
 +
* When done making changes, click on '''Save'''.
 +
=====Locked posts=====
 +
Data processing and analysis should be collaborative. When you start editing a Post, it will be locked and other users cannot edit, update, or accidentally interfere with your work. When you finish working and save or close the post, it is automatically unlocked again. Conversely, if you need to edit a Post that is currently locked you will be able to quickly find out which of your colleagues is working on it and coordinate changes with them.<br>
 +
To avoid issues with Posts remaining locked, we have introduced a set of safeguards to ensure that the Posts will always return to an unlocked state.
 +
* Locks expire after 5 minutes, to avoid locking a post when someone is not actively working on it.
 +
* When a user logs out, all of their locked posts will be unlocked.
 +
* Administrators have the right to “break” a lock to ensure that a Post becomes available again in a time sensitive situation.
 +
* Even when locked for edit, all users who have permission are able to view and review the Post.
 +
[[File:TheNeedle68.png|400px|thumb|center|]]<br>
  
−
Please note that information displayed to users on each of these pages is dependent on permissions granted to registered/non registered users by the deployment administrator e.g Published posts, Unknown posts and My posts, and menu bars allowing for editing and deletion are only visible to logged in users with necessary granted permissions( See more on Roles in Section 4.1 of this manual)
 
−
====Filtering Posts====
 
−
====Adding Posts====
 
−
====Editing Posts====
 
 
====Publising Posts====
 
====Publising Posts====
 +
The ability to publish posts is only available to admins or registered users with adequate permissions. This means that non registered users cannot publish posts. Posts submitted by non registered users have to be moderated.<br>
 +
To publish a post, simply change the status to Published as shown below:
 +
* From the data view page, either
 +
** Individually or
 +
[[File:TheNeedle69.png|400px|thumb|center|]]<br>
 +
[[File:TheNeedle70.png|400px|thumb|center|]]<br>
 +
** in Bulk
 +
[[File:TheNeedle71.png|400px|thumb|center|]]<br>
 +
[[File:TheNeedle72.png|400px|thumb|center|]]<br>
 +
* From the post detail view
 +
[[File:TheNeedle73.png|400px|thumb|center|]]<br>
 +
* While editing a post
 +
[[File:TheNeedle74.png|400px|thumb|center|]]<br>
 +
* Then, click on '''Save'''.
 +
 
====Deleting Posts====
 
====Deleting Posts====
−
====Importing  Posts====
+
The ability to delete posts is only available to admins or registered users with adequate permissions. This means that non registered users cannot delete posts.<br>
−
====Exporting Posts====
+
You can select multiple posts to delete at a time from the post list page, or delete individual posts from the list page, or individual post view page.
 +
To delete
 +
* An individual post from the data view, click on the three dotted icon from the list of detail pane as shown below, then click on '''Delete'''
 +
[[File:TheNeedle75.png|400px|thumb|center|]]<br>
 +
[[File:TheNeedle76.png|400px|thumb|center|]]<br>
 +
* A pop up box will appear on the top of the page, prompting you to confirm whether you would like to delete your post
 +
** Click on '''Delete''' to delete your post
 +
** If you’d like to cancel the post deletion process, click on '''Cancel'''
 +
[[File:TheNeedle78.png|400px|thumb|center|]]<br>
 +
* Multiple posts from the post lists page
 +
** Click on bulk actions, then tick the checkbox on the left, adjacent to the post(s) you would like to delete from the posts list page. You can also click on '''Select All''' to grab all posts listed on that page.
 +
[[File:TheNeedle79.png|400px|thumb|center|]]<br>
 +
** This action will activate the previously inactive '''Delete''' button on the grey menu bar.
 +
** Click on it to initiate the deletion process
 +
[[File:TheNeedle80.png|400px|thumb|center|]]<br>
 +
* A black pop up box will appear on the top of the page, prompting you to confirm whether you would like to delete your post(s)
 +
** Click on '''Delete''' to delete your post(s)
 +
** If you’d like to cancel the post deletion process, click on '''Cancel'''
 +
[[File:TheNeedle81.png|400px|thumb|center|]]<br>
 +
 
 +
==Analysing Data on your deployment==
 +
===Saved Searches===
 +
Saved searches are dynamic groupings of posts that match parameters chosen in filters.They are dynamic because as new posts are added that fit the search criteria, they will show in the saved search automatically, and without manual intervention.<br>
 +
Saved searches are particularly useful for managing workflows and teams on your deployment. They allow you to set filters for information that’s relevant to each working group/team. For example:
 +
* It is useful for a team tasked with structuring to only see posts that are unstructured. Creating a saved search with these parameters will be useful
 +
* A team tasked with publishing needs to only see posts that are yet to be published, so creating a saved search with these parameters will be useful.
 +
Please note that only registered users can create Saved searches. Non registered users can only view public searches
 +
====Creating a saved search====
 +
You can create a saved search from your homepage by:
 +
* Adding your search/filter parameters on the search bar as shown below.
 +
** A '''Save Search''' button will appear on the search and filter modal.
 +
[[File:TheNeedle82.png|400px|thumb|center|]]<br>
 +
** Click on it.
 +
* A small pop up box will appear, asking you to fill in the following details:
 +
[[File:TheNeedle83.png|400px|thumb|center|]]<br>
 +
** Assign a '''saved search name'''
 +
** Provide a '''description'''
 +
** Set the '''audience''' allowed to see this saved search
 +
** Set the '''default viewing mode''' for this saved search(choosing between Map, Data or Activity). This is the view that a user will see when they first arrive at this saved search
 +
** Determine if this saved search is '''featured''' or not. Setting this saved search as featured displays to all users on the saved search menu
 +
* Click on '''Save&Close''' when done.
 +
* Your saved search should now appear on the '''Saved Searches''' menu bar on your search bar.
 +
[[File:TheNeedle84.png|400px|thumb|center|]]<br>
 +
====Updating a saved search====
 +
You can update a saved search at any time by adding/editing your filters/keywords, or turning off existing filters/keywords.
 +
* Set your parameters on the search bar by either typing or selecting options from the search
 +
* An '''Update Search''' button will appear on the menu bar on the left of your screen. Click on it.
 +
[[File:TheNeedle85.png|400px|thumb|center|]]<br>
 +
====Adding a notification to a saved search====
 +
Not Implemented
 +
====Editing a saved search====
 +
To edit a saved search,
 +
* Select saved search you would like to edit from the search filter.
 +
[[File:TheNeedle86.png|400px|thumb|center|]]<br>
 +
* Click on '''Edit''' as shown below:
 +
[[File:TheNeedle87.png|400px|thumb|center|]]<br>
 +
* Edit your saved search details, then click on '''Save&Close'''.
 +
[[File:TheNeedle88.png|400px|thumb|center|]]<br>
 +
 
 +
====Deleting a saved search====
 +
To delete a saved search,
 +
* Select saved search you would like to delete
 +
* Click on the three dots button, right next to the '''Edit''' button.
 +
[[File:TheNeedle89.png|400px|thumb|center|]]<br>
 +
* Click on '''Delete'''. A pop up box will appear on the top of the page, prompting you to confirm whether you would like to delete your saved search.
 +
[[File:TheNeedle90.png|400px|thumb|center|]]<br>
 +
[[File:TheNeedle91.png|400px|thumb|center|]]<br>
 +
* Click on '''OK''' to delete your saved search
 +
* If you’d like to cancel the saved search deletion process, click on '''Cancel'''
 +
 
 +
===Collections===
 +
A “Collection” is a manually-curated grouping of posts. It is not dynamic, meaning the posts within it do not change unless a you manually update them.<br>
 +
You may find collections useful in grouping posts that you would like to share with external partners . For example , you may find it useful to add allposts that require escalation to a collection and then export data in that collection in a CSV file that youcan share with partners.<br>
 +
Please note that only registered users can create Collections. Non registered users can only view featured public collections
 +
====Creating new collections====
 +
To create a new collection,
 +
* Click on by clicking on:
 +
** Collections icon on the bottom left hand corner of your deployment as illustrated below.
 +
[[File:TheNeedle92.png|400px|thumb|center|]]<br>
 +
** The three dotted icon on the data view page while viewing the list on the left and the detailed pane on the right. ( note that this will assign this post to the new collection created.
 +
[[File:TheNeedle93.png|400px|thumb|center|]]<br>
 +
[[File:TheNeedle94.png|400px|thumb|center|]]<br>
 +
** A pop up box will appear, with a list of all existing collections, and a '''Create new''' button. Click on it.
 +
[[File:TheNeedle95.png|400px|thumb|center|]]<br>
 +
** Then, fill in the following details:
 +
[[File:TheNeedle96.png|400px|thumb|center|]]<br>
 +
*** Assign a '''Collection name'''
 +
*** Provide a '''description'''
 +
*** Set the '''audience''' allowed to see this collection
 +
*** Set the '''default viewing mode''' for this collection (choosing between Map, Activity, or Data). This is the view that a user will see when they first arrive at this collection
 +
*** Determine if this collection is '''featured''' or not. Setting this collection as featured displays to all users on the collections menu
 +
** Click on '''Save&Close''' when done.
 +
** Your collection should now appear on the left menu bar under '''Collections'''
 +
 
 +
====Adding Posts to collections====
 +
You can add a post to a collection from:
 +
* The three dotted icon on the data view page while viewing the list on the left and the detailed pane on the right.
 +
[[File:TheNeedle97.png|400px|thumb|center|]]<br>
 +
[[File:TheNeedle98.png|400px|thumb|center|]]<br>
 +
* A pop up box will appear, with a list of all existing collections. Select the collection(s) you’d like to add the post to.
 +
[[File:TheNeedle99.png|400px|thumb|center|]]<br>
 +
* You can add a post to multiple collections, so tick all checkboxes that apply.
 +
* You can also create a new collection to add the post to from these two pages. Simply click on Create New from within this dropdown as described in the Creating new collections.
 +
 
 +
====Adding notifications to collections====
 +
Not Implemented
 +
====Adding notifications to collections====
 +
As a registered and logged in user, you can set up notifications on Collections. This means that any time a post is added to a collection, you will receive an email or phone notification.
 +
To add a notification,
 +
* Click on the collection you’d like to receive notifications from.
 +
* Click on the three dots button, right next to the '''Edit''' button.
 +
[[File:TheNeedle100.png|400px|thumb|center|]]<br>
 +
* Click on '''Get Notifications'''.
 +
[[File:TheNeedle101.png|400px|thumb|center|]]<br>
 +
* You can turn off notifications for this collection using the same process described above.
 +
 
 +
====Editing Collections====
 +
To edit a Collection,
 +
* Click on the collection you would like to edit
 +
* Click on '''Edit''' as shown below:
 +
[[File:TheNeedle102.png|400px|thumb|center|]]<br>
 +
* Edit your Collection details, then click on '''Save&Close'''.
 +
[[File:TheNeedle103.png|400px|thumb|center|]]<br>
 +
 
 +
====Deleting Collections====
 +
To delete a collection,
 +
* Click on the collection you would like to delete
 +
* Click on the three dots button, right next to the '''Edit''' button.
 +
[[File:TheNeedle104.png|400px|thumb|center|]]<br>
 +
[[File:TheNeedle105.png|400px|thumb|center|]]<br>
 +
* Click on '''Delete'''. A pop up box will appear on the top of the page, prompting you to confirm whether you would like to delete your collection.
 +
[[File:TheNeedle106.png|400px|thumb|center|]]<br>
 +
* Click on '''OK''' to delete your collection
 +
* If you’d like to cancel the collection deletion process, click on '''Cancel'''
 +
 
 
=Credits=
 
=Credits=
 
This platform is based on the Ushahidi platform please see their website at http://www.ushahidi.com/
 
This platform is based on the Ushahidi platform please see their website at http://www.ushahidi.com/

Latest revision as of 07:38, 28 September 2022

TheNeedle

TheNeedle Platform helps communities turn information into action with an intuitive and accessible crowdsourcing and mapping tool.
By enabling the rapid collection, management and analysis of crowdsourced information from NPS-OSINT and other sources, TheNeedle empowers everyone—individuals, community groups, governments, activists, organizations—to create meaningful change.

Managing People on your deployment

Roles

This feature allows you to set up and manage default and custom roles and permissions for different user groups on your deployment. Each deployment has a default “Admin” and "Member" role, which cannot be deleted, but can be edited. The default “Admin” role allows for full control over ALL functionality on your deployment, while the default "Member" role only grants access to edit their own posts.

Setup Guide

To access the roles management page,

  • On the left hand menu bar, click on Settings
Settings button on the TheNeedle Platform sidebar


  • Then, click on Roles
Settings list page. Roles button highlighted


  • You’ll be redirected to a page with a list of all existing roles - default & custom roles (created by admins if any exist).
Add Role

To add a custom user role,

  • Click on the yellow Add icon
Settings list page. Roles button highlighted


  • Add the following details
    • Name: Provide a name for this new custom role
    • Description: Provide a brief description of what/who this custom role has been created for
    • Set your permissions. Below is a brief breakdown of what permissions get granted to users on selecting the options provided.
      • Manage Users: Allows for;
        • Viewing Users
        • Adding, Editing, Deleting Users
        • and Changing roles for Users
      • Manage Posts: Allows for;
        • Viewing posts
        • Editing and Deleting Posts
        • Publishing posts (Setting specific audiences to view )
        • Adding posts to collections
        • Creating new collections
      • Manage Settings: Allows for managing;
        • General Settings
        • Map Settings
        • Data Sources
        • Surveys
        • Categories
      • Bulk Data import and Export: Allows for upload of data via CSV files and exporting files.
      • Edit their own posts: Allows for editing of posts submitted by user
      • Manage collections and saved searches: Allows for
        • Addition posts to all saved searches/collections on
        • Removing posts from all saved searches/collections
        • Editing all saved searches/collections
        • Deleting all saved searches/collections
    • Click on Save.
The add role page contains a role name, description, and preferred permissions.


Edit Role

To edit a role

  • Click on a role from the list provided to you.
Click on a role from the Role.


  • On redirection to the edit page, make your desired changes to the role (i.e fill out details as directed in the Add role section)
  • Click on Save to update the role.
Adding details to a new role. Name, description and permission fields available.


Delete Role
  • To delete a role
  • Click on a role from the Roles management list page
Selecting a role in the roles list.


  • Then, click on the Delete This Role button at the bottom of the page
Click the DELETE THIS ROLE button.


  • A pop up box will appear on the top of the page, prompting you to confirm whether you would like to delete the custom role. If
    • You would like to proceed with deletion, click on Delete
    • You would not like to proceed with deletion, click on Cancel
Delete role confirmation pop up.


Users

Setup guide

To access the User management page,

  • On the left hand menu bar, click on Settings
Settings button on the TheNeedle Platform sidebar


  • Then, click on Users.
Settings -> Users


  • You’ll be redirected to a page with a list of all existing users on your deployment
  • From here, you can search for users either by name or by custom role
TheNeedle11.png


TheNeedle12.png


Adding new users

To add a new user,

  • Click on the yellow icon as shown below
TheNeedle13.png


  • Fill out the details below
    • Display Name: This is the name that will be displayed
    • Email address: This is the email address that will be tied to this new user’s account, and will be used to log in.
    • Password: Set a strong and secure password for your new user. Each password must have at least 7 characters
    • Role: Choose the level of administration access you would like this user to have
  • Click on Save to create one.
TheNeedle14.png


Editing users

To edit a user,

  • Click on the user you intend to edit from the user list page
TheNeedle15.png


  • You should be able to edit the user’s display name, email address, password and user role from this page.
TheNeedle16.png


  • Click on Save when done.
Changing User roles

You can change multiple users’ roles at once from the user management page.

  • Tick the checkbox on the left, adjacent to the user(s) whose role you would like to change from the user list page
  • This action will activate the previously inactive Change Role dropdown button on the top menu bar.
TheNeedle17.png


  • Click on this dropdown and select the role you would like to assign your users to.
TheNeedle18.png


  • A pop up box will appear, prompting you to confirm whether you would like to change the roles of your user(s)
    • Click on OK to change your user(s) role
    • If you’d like to cancel the role change process, click on Cancel.
TheNeedle19.png


Deleting users

Similarly, you can delete multiple users at once from the user management page, or from the individual user edit page.
To delete a user

  • From the individual user edit page
    • Click on the user you intend to edit from the user list page.
TheNeedle20.png


    • Click on Delete User.
TheNeedle21.png


    • A pop up box will appear on the top of the page, prompting you to confirm whether you would like to delete your user
      • Click on Delete to delete your user
      • If you’d like to cancel the user deletion process, click on Cancel.
TheNeedle22.png


    • From the User management page
      • Tick the checkbox on the left, adjacent to the user(s) you would like to delete from the user list page
      • This action will activate the previously inactive Delete button on the top menu bar. Click on it to initiate the deletion process.
TheNeedle23.png


      • A pop up box will appear, prompting you to confirm whether you would like to delete your user(s)
        • Click on Delete to delete your user(s)
        • If you’d like to cancel the user deletion process, click on Cancel.
TheNeedle24.png


Modes for visualizing and managing data on your deployment

TheNeedle platform provides you with modes to not only visualise your data in different ways, but to also manage it.
We designed “modes” for the discrete and specific actions users need to take within the platform, in a bid to make the platform to be more intuitive and action-oriented for different user types on a deployment. Ordinary viewers of deployment can access three different modes as shown below:-

  • Map view
  • Data view
  • Activity view
  • Then, click on Users.
Logged out version of the sidebar of an TheNeedle deployment.


Signed in users(with the necessary permissions) can access four different modes as shown below:-

  • Map view
  • Data view
  • Activity view
  • Settings page
Logged in version of the sidebar of an TheNeedle deployment.


Your TheNeedle deployment defaults to the map mode for anyone who visits your homepage(as illustrated above). To change your current mode, select any of the options provided to you from the menu on your left.

Map View

This mode displays all published posts on a map.

  • Each post appears as an icon on the map. In the event that you opted to combine nearby posts on your Map settings page, posts adjacent to each other on the map will cluster together, displaying a number denoting number of posts combined.
  • Clicking on each individual post displays a small pop up box with the post title and description.
  • You should also be able to zoom in and out of the map as desired.
Example of the Uchaguzi deployment with the map view.


You also get a breakdown of incoming posts by source, as shown below.

The map view sidebar allows you to filter out Data sources.


Data View

The Data view allows you to view, triage, and manage posts coming into your deployment as a chronological list of events over time. It provides a split pane that lists post summaries on the left pane, and post details and editing features in the right.

A list of posts on the left side of the data view. Click on one to select it.


From here, you should be able to:

  • Add new posts
Adding new posts via the yellow + circle button.


  • View individual post details
  • Edit posts to either change existing structures or assign posts from Twitter, SMS and/or email to a survey
TheNeedle32.png


  • You can also
    • Add posts to collections
    • Publish posts
    • Put posts under review
    • Archive posts
    • Share posts
    • Delete posts
Click on the "..." button on a post to see a list of actions.


Listed actions: edit, add to collection, share, publish, put under review, archive, delete.


  • Get notified when new posts arrive
Click on the "..." button on a post to see a list of actions.


  • Perform bulk actions( publishing, putting under review, archiving, adding to collections and deleting) on multiple posts at a time
Highlighted: bulk actions button.


Highlighted: bulk actions. Publish, Put under review, Archive.


NB: Data displayed on this page is dependent on permissions granted to the user viewing this page

Activity View

This mode gives you a summary of how people are interacting with your deployment over time.

Highlighted: select time frame button.


Highlighted: time filters.


You can compare

  • Activity over time
Activity over time. Select "Compare" dropdown to get different types of activity data.


You can filter post count in a line chart over time by:-

  • All posts
  • Categories that the posts belong to
  • Surveys that the posts were submitted to
  • Status i.e whether they’re published or not
Highlighted: compare options. All posts, categories, surveys, statuses.


You can opt to view your post counts on the graph as cumulative totals.

  • Activity by Volume
Highlighted: comparison type dropdown. "Categories" option selected.


  • You can filter post count in a bar chart by volume by:-
    • Categories that the posts belong to
    • Surveys that the posts were submitted to
    • Status i.e whether they’re published or not
Highlighted: comparison type dropdown. "Categories" option selected. Other options: survey and status.


Managing Data in your deployment

A post is a report of a single instance of something in the deployment. It can be made up of many fields, such as Title, Description, Date, Links, and/or location. TheNeedle allows for collection of posts via

  • Web (NPS-OSINT): You can setup a feed from nps-osint.co.za based on specific keywords, search terms, and/or artificial intelligence message classifiers.

This chapter will describe how to manage data coming in from these different sources.

Setup Guides

Viewing Posts

Posts on your deployment can be categorised into two types of data:-

  • Structured: Incoming posts from the web platform and smartphone applications are classified as structured posts, since they adhere to the structure of surveys created on your deployment.
  • Unstructured/Unknown: Incoming messages from SMS, Twitter and Email are classified as unknown posts, since they do not adhere to the structure of surveys created on your deployment. This means that these messages come in their raw form, and have to be manually structured by admins/anyone with permissions to edit posts, to fit into the structure of your survey. E.g an SMS message “Hello, my name is Angela” will need to be broken down into a title, a description, properly categorised etc.

You can view posts in either Map, Data or Activity mode. We'd previously discussed each of these modes separately in Chapter 5.

TheNeedle46.png


For purposes of managing your data, we recommend using Data Mode. From this page, You should be able to see the following:-

  • A list of all posts in chronological order of when they were submitted into the platform. You can opt to change the order of the posts either through options provided in the search filter ( we'll dive into filtering posts in the next section )
  • Post visibility Status: You can tell if a post is public or only visible to a specific audience
  • Post source (is it from the NPS-OSINT or another source?).
TheNeedle47.png


  • Structured posts via web/smartphones will have their respective source label on them.
  • Unstructured posts will have a label denoting their source, as seen below with this sample NPS-OSINT message
TheNeedle48.png


  • When the post was submitted: Hovering over the timestamp of the post will give additional details on specific timing as shown below.
TheNeedle49.png


  • Individual Post descriptions on the left pane, and post details on selection of a post card on the right pane
TheNeedle50.png


  • When viewing post details on the right pane, you'll be able to see additional details such as location, categories, and tasks.
TheNeedle51.png


  • If you’re an admin/your user role permits, you’ll should also be able to see the Edit button on the top right-hand corner of your page
TheNeedle52.png


NB: Locked posts - The platform allows for post locking, to avoid duplication of efforts. If someone on your team is currently editing a post, it is locked and made unavailable for you to edit. In this case, the edit button will not be visible to you, despite having adequate permissions.

  • Every post has a three-dotted icon as shown below. Depending on what permissions are granted to the person viewing, this button allows you to
    • Add your post to a collection (public)
    • Share this post (public) via facebook, twitter, embed on another website or export it to a CSV file.
    • Edit your post (limited by role)
    • Publish your post (limited by role)
    • Put your post under review, setting visibility to only members of your team (limited by role)
    • Archive your post (limited by role)
    • Delete your post (limited by role)
TheNeedle53.png


TheNeedle54.png


  • A search filter that allows you to
    • sort posts by
      • Date of creation
      • Post date i.e date when it was assigned to a survey
      • Date updated
    • filter reports by Saved searches, Status, Surveys, Categories, Data source, Date range, Location or any other user determined parameters.
TheNeedle55.png


TheNeedle56.png


Please note that information displayed to users on each of these pages is dependent on permissions granted to registered/non registered users by the deployment administrator e.g Published posts, Unknown posts and My posts, and menu bars allowing for editing and deletion are only visible to logged in users with necessary granted permissions.

Filtering Posts

Filters can be applied to narrow down a large amount of data. You can filter posts by many types of parameters, for example: Surveys, Categories, Status, Date Ranges, and Location.
Survey and Category filters are located within the "Filters" modal on the top global search bar, which allows you to

  • sort posts by
    • Date of creation
    • Post date i.e date when it was assigned to a survey
    • Date updated
  • filter reports by
    • Saved searches
      • By default, every deployment has a set of three featured Saved Searches(read more in the Saved Searches section of this manual) from which you can view posts on your deployment, from the search filter.These include:-
        • Published Posts: Lists all posts that have been made public on your deployment(i.e can be viewed by registered/non-registered users on your deployment.
        • Unknown Posts: Lists all messages received from SMS, Email and Twitter, that have not been assigned to a survey i.e are unstructured
        • My posts: Lists all posts created by you as a user
    • Status
      • Published: Posts that can be seen by both logged in and non logged in users
      • Under review: Posts that can only be seen by logged in users with adequate permissions
      • Archived: Posts that have been deemed to be irrelevant and removed from your active view
    • Other filters include Surveys, Categories, Data source, Date range, Location or any other user determined parameters
TheNeedle55.png


TheNeedle56.png


Filters are additive, so you can apply as many as you would like. This search filter is available on all pages.

Adding Posts

Directly from the NPS-OSINT Registered users can create posts using the same process described below. For descriptive purposes, the post below has one tasks. To create a post,

  • Click on the yellow add icon as shown below on your homepage, or on the bottom left corner on the data mode page
TheNeedle59.png


  • In the event that you have multiple surveys on your deployment, you’ll have to choose the survey from a list of all surveys available on your deployment.
TheNeedle60.png


  • At the upper left corner of the page, click on the dropdown menu and see the available languages that the survey form can be viewed in, click on the language you prefer and fill the form in the chosen language.
  • Make sure to fill out all fields with a red asterisk beside them, You will not be able to save or publish your post before these fields are filled out.
    • NB: Users are now able to submit improvements to the OpenStreetMap Basemap, directly from the post submission page. In some cases, base maps are not up to date. We highly encourage you to contribute to improving base maps in your locations of interest. For more details on how to improve OpenStreetMap, visit the OSM wiki here.
  • Make sure to fill out any tasks visible to you on this submission page as well. NB: You can submit posts without filling out or completing tasks. However, in the event that your task is a requirement for publishing, this post will not be published unless the task is marked as complete.
  • When you’re done adding content for your post, click on Submit.
TheNeedle61.png


  • Your post will be submitted to the deployment’s admin for review before publishing.

Editing Posts

The post editing function is only available to admins or registered users with adequate permissions. This means that non registered users cannot edit posts.
This feature is particularly useful when creating posts out of unstructured posts (messages from SMS, Email, Twitter).
To edit a post,

  • Select a post from your data view
TheNeedle62.png


TheNeedle63.png


  • Click on Edit. This will load the post editor on the right pane of your page, where you’ll be able to edit any of the content.
TheNeedle64.png


TheNeedle65.png


TheNeedle66.png


  • If you're logged in and have adequate permissions you should also be able to change the status of your post.
TheNeedle67.png


  • When done making changes, click on Save.
Locked posts

Data processing and analysis should be collaborative. When you start editing a Post, it will be locked and other users cannot edit, update, or accidentally interfere with your work. When you finish working and save or close the post, it is automatically unlocked again. Conversely, if you need to edit a Post that is currently locked you will be able to quickly find out which of your colleagues is working on it and coordinate changes with them.
To avoid issues with Posts remaining locked, we have introduced a set of safeguards to ensure that the Posts will always return to an unlocked state.

  • Locks expire after 5 minutes, to avoid locking a post when someone is not actively working on it.
  • When a user logs out, all of their locked posts will be unlocked.
  • Administrators have the right to “break” a lock to ensure that a Post becomes available again in a time sensitive situation.
  • Even when locked for edit, all users who have permission are able to view and review the Post.
TheNeedle68.png


Publising Posts

The ability to publish posts is only available to admins or registered users with adequate permissions. This means that non registered users cannot publish posts. Posts submitted by non registered users have to be moderated.
To publish a post, simply change the status to Published as shown below:

  • From the data view page, either
    • Individually or
TheNeedle69.png


TheNeedle70.png


    • in Bulk
TheNeedle71.png


TheNeedle72.png


  • From the post detail view
TheNeedle73.png


  • While editing a post
TheNeedle74.png


  • Then, click on Save.

Deleting Posts

The ability to delete posts is only available to admins or registered users with adequate permissions. This means that non registered users cannot delete posts.
You can select multiple posts to delete at a time from the post list page, or delete individual posts from the list page, or individual post view page. To delete

  • An individual post from the data view, click on the three dotted icon from the list of detail pane as shown below, then click on Delete
TheNeedle75.png


TheNeedle76.png


  • A pop up box will appear on the top of the page, prompting you to confirm whether you would like to delete your post
    • Click on Delete to delete your post
    • If you’d like to cancel the post deletion process, click on Cancel
TheNeedle78.png


  • Multiple posts from the post lists page
    • Click on bulk actions, then tick the checkbox on the left, adjacent to the post(s) you would like to delete from the posts list page. You can also click on Select All to grab all posts listed on that page.
TheNeedle79.png


    • This action will activate the previously inactive Delete button on the grey menu bar.
    • Click on it to initiate the deletion process
TheNeedle80.png


  • A black pop up box will appear on the top of the page, prompting you to confirm whether you would like to delete your post(s)
    • Click on Delete to delete your post(s)
    • If you’d like to cancel the post deletion process, click on Cancel
TheNeedle81.png


Analysing Data on your deployment

Saved Searches

Saved searches are dynamic groupings of posts that match parameters chosen in filters.They are dynamic because as new posts are added that fit the search criteria, they will show in the saved search automatically, and without manual intervention.
Saved searches are particularly useful for managing workflows and teams on your deployment. They allow you to set filters for information that’s relevant to each working group/team. For example:

  • It is useful for a team tasked with structuring to only see posts that are unstructured. Creating a saved search with these parameters will be useful
  • A team tasked with publishing needs to only see posts that are yet to be published, so creating a saved search with these parameters will be useful.

Please note that only registered users can create Saved searches. Non registered users can only view public searches

Creating a saved search

You can create a saved search from your homepage by:

  • Adding your search/filter parameters on the search bar as shown below.
    • A Save Search button will appear on the search and filter modal.
TheNeedle82.png


    • Click on it.
  • A small pop up box will appear, asking you to fill in the following details:
TheNeedle83.png


    • Assign a saved search name
    • Provide a description
    • Set the audience allowed to see this saved search
    • Set the default viewing mode for this saved search(choosing between Map, Data or Activity). This is the view that a user will see when they first arrive at this saved search
    • Determine if this saved search is featured or not. Setting this saved search as featured displays to all users on the saved search menu
  • Click on Save&Close when done.
  • Your saved search should now appear on the Saved Searches menu bar on your search bar.
TheNeedle84.png


Updating a saved search

You can update a saved search at any time by adding/editing your filters/keywords, or turning off existing filters/keywords.

  • Set your parameters on the search bar by either typing or selecting options from the search
  • An Update Search button will appear on the menu bar on the left of your screen. Click on it.
TheNeedle85.png


Adding a notification to a saved search

Not Implemented

Editing a saved search

To edit a saved search,

  • Select saved search you would like to edit from the search filter.
TheNeedle86.png


  • Click on Edit as shown below:
TheNeedle87.png


  • Edit your saved search details, then click on Save&Close.
TheNeedle88.png


Deleting a saved search

To delete a saved search,

  • Select saved search you would like to delete
  • Click on the three dots button, right next to the Edit button.
TheNeedle89.png


  • Click on Delete. A pop up box will appear on the top of the page, prompting you to confirm whether you would like to delete your saved search.
TheNeedle90.png


TheNeedle91.png


  • Click on OK to delete your saved search
  • If you’d like to cancel the saved search deletion process, click on Cancel

Collections

A “Collection” is a manually-curated grouping of posts. It is not dynamic, meaning the posts within it do not change unless a you manually update them.
You may find collections useful in grouping posts that you would like to share with external partners . For example , you may find it useful to add allposts that require escalation to a collection and then export data in that collection in a CSV file that youcan share with partners.
Please note that only registered users can create Collections. Non registered users can only view featured public collections

Creating new collections

To create a new collection,

  • Click on by clicking on:
    • Collections icon on the bottom left hand corner of your deployment as illustrated below.
TheNeedle92.png


    • The three dotted icon on the data view page while viewing the list on the left and the detailed pane on the right. ( note that this will assign this post to the new collection created.
TheNeedle93.png


TheNeedle94.png


    • A pop up box will appear, with a list of all existing collections, and a Create new button. Click on it.
TheNeedle95.png


    • Then, fill in the following details:
TheNeedle96.png


      • Assign a Collection name
      • Provide a description
      • Set the audience allowed to see this collection
      • Set the default viewing mode for this collection (choosing between Map, Activity, or Data). This is the view that a user will see when they first arrive at this collection
      • Determine if this collection is featured or not. Setting this collection as featured displays to all users on the collections menu
    • Click on Save&Close when done.
    • Your collection should now appear on the left menu bar under Collections

Adding Posts to collections

You can add a post to a collection from:

  • The three dotted icon on the data view page while viewing the list on the left and the detailed pane on the right.
TheNeedle97.png


TheNeedle98.png


  • A pop up box will appear, with a list of all existing collections. Select the collection(s) you’d like to add the post to.
TheNeedle99.png


  • You can add a post to multiple collections, so tick all checkboxes that apply.
  • You can also create a new collection to add the post to from these two pages. Simply click on Create New from within this dropdown as described in the Creating new collections.

Adding notifications to collections

Not Implemented

Adding notifications to collections

As a registered and logged in user, you can set up notifications on Collections. This means that any time a post is added to a collection, you will receive an email or phone notification. To add a notification,

  • Click on the collection you’d like to receive notifications from.
  • Click on the three dots button, right next to the Edit button.
TheNeedle100.png


  • Click on Get Notifications.
TheNeedle101.png


  • You can turn off notifications for this collection using the same process described above.

Editing Collections

To edit a Collection,

  • Click on the collection you would like to edit
  • Click on Edit as shown below:
TheNeedle102.png


  • Edit your Collection details, then click on Save&Close.
TheNeedle103.png


Deleting Collections

To delete a collection,

  • Click on the collection you would like to delete
  • Click on the three dots button, right next to the Edit button.
TheNeedle104.png


TheNeedle105.png


  • Click on Delete. A pop up box will appear on the top of the page, prompting you to confirm whether you would like to delete your collection.
TheNeedle106.png


  • Click on OK to delete your collection
  • If you’d like to cancel the collection deletion process, click on Cancel

Credits

This platform is based on the Ushahidi platform please see their website at http://www.ushahidi.com/

Retrieved from ‘https://wiki.nptracker.co.za/index.php?title=TheNeedle&oldid=6609’