FOR ARCHIVAL PURPOSES ONLY

The information in this wiki hasn't been maintained for a good while. Some of the projects described have since been deprecated.

In particular, the "Ushahidi Platform v3.x" section contains information that is often misleading. Many details about this version of Platform have changed since.

This website is an extraction of the original Ushahidi wiki into a static form. Because of that, functions like logging in, commenting or searching will not work.

For more documentation, please refer to https://docs.ushahidi.com

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0

Table

Description

Relevant areas of the Ushahidi UI/Functionality

Comments

actions

Stores user defined actions triggered by certain events e.g, assign a badge when a user submits 3 reports

Admin->Manage->Actions

*

actions_log

Stores a log of actions triggered, user who triggered it and date it was triggered

Admin->Manage->Actions

*

alert

Stores alerts subscribers’ information(phone number/email address, and subscription confirmation, location radius of alerts to be sent to them)

Get Alerts

*

alert_category

Stores categories subscribers would like to recieve alerts about

Get Alerts

*

alert_sent

Stores a log of alerts sent out to subscribers

*

*

api_banned

Stores a list of all IP addresses banned from accessing a deployment’s API

Admin->Settings->API->
API logs(you can ban an IP from here)
-Admin->Settings->API->
API Banned

*

api_log

Stores a log of all API tasks, parameters and returns carried out, along with the date of access and accessing IP

-Admin->Settings->API->
API logs

*

api_settings

Stores boundaries/limitations set with regards to API access

-Admin->Settings->API->
API Settings

*

badge

Stores description of badges to be assigned

-Admin->Manage->Badges

*

badge_users

Stores assigned badge information i.e user and corresponding badge assigned to that particular user

-Admin->Manage->Badges(you can assign a badge to a user from this page)

*

category

Holds information about categories defined for a deployment

-Admin->Dashboard
-Admin->Manage->Categories
-Admin->Reports->View Reports
-Admin->Reports->Create Report
-Admin->Reports->Download
-Homepage
-Reports
-Reports->More information(for an individual report)
-Submit a report
-Get alerts

*

category_lang

Holds translations for category titles and descriptions in selected languages

Same as above

*

checkin

Stores checkin information - for deployments that have checkins enabled

-Homepage
-Admin->Checkins(if enabled)

*

city

Stores cities of countries retrieved by user.

-Admin->Settings->Map(the retrieve cities from geonames link populates this table)
-Admin->Reports->Create report
-Submit a report

*

cluster

Stores informations used for clustering of reports on the map.

-Homepage (Main map)

*

comment

Stores comments made on reports/checkins

-Report details
-Admin->Reports->Comments

*

country

Stores a list of all countries in the world and their capital cities

-Admin->Settings->Map(
Used in the Map settings page when selecting the default country your deployment should span over)
-Admin->Reports->View Reports

*

externalapp

Stores information about any external apps that communicate with your deployment, mainly our mobile apps(iPhone and Android)

-Homepage(Links to mobile apps on the How to Report Box on the main page)

*

feed

Stores information about RSS Feeds a deployment subscribes to

-Admin->Dashboard
-Admin->Manage->News Feeds->Feeds

*

feed_item

Stores feed items pulled from each RSS Feed

-Homepage->Official and Mainstream news
->Admin->Manage->News Feeds->Feed Items

*

form

Stores all report submission forms created(default+custom)

-Admin->Manage->Forms
-Admin->Reports->Create report
-Submit a report

*

form_field

Stores all custom form fields created by users

-Admin->Manage->Forms
-Admin->Reports->Create report
-Admin->Reports->Download
-Reports->More information(for an individual report)
-Submit a report

*

form_field_option

Stores options related to custom form fields e.g, who can submit answers, toggle field or not etc

-Admin->Manage->Forms->Edit form fields

*

form_response

Stores responses to custom form fields

-Admin->Reports->Edit Reports
-Admin->Reports->Download
-Reports->More information(for an individual report)

*

geometry

Stores map geometries i.e polygons, lines etc

-Reports->More information(for an individual report)
-Submit a report
-Admin->Reports->Create report

*

incident

Stores reports submittted

-Homepage(main map)
-Reports
-Reports->More information(for an individual report)
-Admin->Dashboard
-Admin->Reports->View reports
-Admin->Reports->Edit report
-Admin->Reports->Comments
-Admin->Reports->Download

*

incident_category

Stores stored reports’ categories

-Admin->Reports->View Reports
-Admin->Reports->Edit
-Admin->Reports->Download
-Homepage(main map)
-Reports
-Reports->More information(for an individual report)

*

incident_lang

Holds translations for report titles and descriptions in selected languages

Same as above

*

incident_person

Holds information provided by people who submit reports with their personal information i.e name, email address, phone number

-Admin->Reports->View Reports
-Admin->Reports->Edit report

*

layer

Holds static layer information

-Admin->Manage->Layers
-Homepage->Layers

*

level

Stores level of trust assigned to reporters of the platform

-Admin->Messages->SMS->Reporters
-Admin->Messages->Email->Reporters
-Admin->Messages->Twitter->Reporters

To be affected if reporters table is removed. Was classified as a dormant table in the platform Benchmarking report

location

Stores location information for submitted reports

-Homepage
-Reports
-Reports->More information(for an individual report)
-Submit a report
-Admin->Dashboard
-Admin->Reports->View Reports
-Admin->Reports->Create report
-Admin->Reports->Download

*

maintenance

Puts a site in maintenance mode if there's any data in this table.IP addresses serve as a whitelist for maintenance mode

 

*

media

Stores any media submitted along with a report/checkin e.g a news link, photo, video

-Reports
-Reports->More information(for an individual report)

*

message

Stores tweets, emails and SMS messages pulled into a deployment

-Admin->Dashboard
-Admin->Messages->SMS
-Admin->Messages->Twitter
-Admin->Messages->Email

*

openid

Stores users’ openid information

Admin->Login(With current changes made to login page, no longer existent)

Maybe OpenID should be made into a plugin? -BH

page

Stores user created pages

-Homepage
-Admin->Manage->Pages

*

permissions

Stores permissions used for access control

-Admin->Users->Manage Roles and Permissions

 

permissions_roles

Stores permissions assigned to roles

-Admin->Users->Manage Roles and Permissions

 

plugin

Holds a list of all plugins installed on a deployment

Admin->Addons->Plugins

*

private_message

Stores private messages sent between Members

-Members->Dashboard
-Members->Private messages

*

rating

Stores credibility ratings assigned to submitted reports

-Admin->Reports->Comments
-Reports->More information(for an individual report)

*

reporter

Holds information about people who submit reports via email, twitter and SMS

-Admin->Messages->SMS->Reporters
-Admin->Messages->Email->Reporters
-Admin->Messages->Twitter->Reporters

Was classified as a dormant table in the platform Benchmarking report

This should probably be removed and we should rely on users for this stuff. May require a little refactoring. -BH

roles

Defines user access levels and privileges on a deployment

-Admin->Users->View Users
-Admin->Users->Add/Edit Users

 

roles_users

Stores roles assigned to users registered on a deployment

-Admin->Users->View Users
-Admin->Users->Add/Edit Users

*

scheduler

Stores schedules for the following tasks:-
* Pulling feeds from twitter, email and sms
* Clean up
* Sharing

Admin->Manage->Scheduler

*

scheduler_log

Stores a log of scheduler actions

Admin->Manage->Scheduler->Scheduler log

*

service

Stores information about different services via which info is pulled into the platform from i.e SMS, Email, Twitter

-Admin->Dashboard
-Admin->Reports->View Reports
-Admin->Messages->SMS
-Admin->Messages->Email
-Admin->Messages->Twitter

*

sessions

Stores session information

*

*

settings

Stores a deployment’s general settings e.g Site name, tagline, copyright statement, etc

Well, basically affects everything on the frontend :)

*

users

Stores registered users’ information

Admin->Users->View Users

*

user_devices

Stores mobile IDs for users. Works with checkins. Ties mobile devices to users without logging in so that the ids on the devices make the distinction

Admin->Checkins

Was classified as a dormant table in the platform Benchmarking report. Might just be removed once RiverID is fully integrated into mobile apps

user_tokens

Stores browser tokens assigned to users

*

*

verified

Stores all verified reports

-Reports
-Reports->More information(for an individual report)

-Admin->Reports->View reports
-Admin->Reports->Edit report
-Admin->Reports->Comments
-Admin->Reports->Download

*