Platform Developer Documentation
Search…
👋
Welcome | README
Code of Conduct
Contributing | Getting Involved
Frequently Asked Questions
Join the Ushahidi community
Contributors ✨
🛣️ The Ushahidi Platform Roadmap
Privacy and security best practices
Development & Code
Development: Overview
How to get the source code
Setup Guides
Add code to Ushahidi
Development process
Coding Standards
Track and submit issues in Github
Upgrading Ushahidi
⚙️ Installation Helper
Tech Stack
API Documentation
Third party app development
Database | Tables overview
Database | Database Schema Diagram
Database | Table details
📐
Architecture
Use case internals
QA & Testing
The QA process
How to run QA tests
Defect Management
How to write QA test scripts
Hotfixes
Front-end development
Changing UI styles: introduction to the pattern library
Design
🎨
Design: overview
'Best practice' design
Ushahidi Platform 'Sticker Sheet'
User testing process
User testing script examples
Synthesising user testing results examples
Open Source Design
Documentation
Documentation
Contributing docs via GitHub
Translation
Localization and Translation
The Ushahidi Platform Facebook bot
The Facebook bot
Hackathon and events
Installathon, May 2019
Write/Speak/Code 2019
Open Design: Bangalore
Open Design: Taipei
📑
Google season of docs
Enhancement Proposals
Exchange Format
Importing data from previous versions
Powered By
GitBook
Database | Table details
Details for all tables in the Platform database
apikeys
Field
Type
Null
Key
Default
Extra
id
int(11)
NO
PRI
NULL
auto_increment
api_key
text
NO
NULL
client_id
text
YES
NULL
client_secret
text
YES
NULL
created
int(11)
NO
0
updated
int(11)
YES
NULL
config
Field
Type
Null
Key
Default
Extra
id
int(11)
NO
PRI
NULL
auto_increment
group_name
varchar(50)
NO
MUL
NULL
config_key
varchar(50)
NO
NULL
config_value
text
YES
NULL
updated
timestamp
NO
MUL
CURRENT_TIMESTAMP
on update CURRENT_TIMESTAMP
contacts
Field
Type
Null
Key
Default
Extra
id
int(11)
NO
PRI
NULL
auto_increment
user_id
int(11)
YES
MUL
NULL
data_source
varchar(150)
YES
MUL
NULL
type
varchar(20)
YES
NULL
contact
varchar(255)
NO
NULL
created
int(11)
NO
MUL
0
updated
int(11)
YES
MUL
NULL
can_notify
tinyint(1)
NO
0
country_codes
Field
Type
Null
Key
Default
Extra
id
int(11)
NO
PRI
NULL
auto_increment
country_name
varchar(255)
NO
0
dial_code
varchar(255)
NO
0
country_code
varchar(255)
NO
MUL
0
csv
Field
Type
Null
Key
Default
Extra
id
int(11)
NO
PRI
NULL
auto_increment
columns
text
NO
NULL
maps_to
text
YES
NULL
fixed
text
YES
NULL
filename
varchar(255)
NO
NULL
size
int(11)
NO
0
mime
varchar(50)
NO
created
int(11)
NO
0
updated
int(11)
YES
NULL
status
varchar(255)
YES
NULL
errors
varchar(255)
YES
NULL
processed
varchar(255)
YES
NULL
collection_id
int(11)
YES
NULL
export_batches
Field
Type
Null
Key
Default
Extra
id
int(11)
NO
PRI
NULL
auto_increment
export_job_id
int(11)
NO
MUL
NULL
status
varchar(255)
NO
pending
batch_number
int(11)
NO
0
filename
varchar(255)
YES
has_headers
tinyint(1)
NO
0
rows
int(11)
NO
0
created
int(11)
NO
0
updated
int(11)
YES
0
export_job
Field
Type
Null
Key
Default
Extra
id
int(11)
NO
PRI
NULL
auto_increment
user_id
int(11)
NO
MUL
NULL
entity_type
varchar(255)
NO
NULL
fields
mediumtext
YES
NULL
filters
mediumtext
YES
NULL
status
varchar(255)
YES
NULL
url
text
YES
NULL
created
int(11)
NO
0
updated
int(11)
NO
0
url_expiration
varchar(12)
YES
0
status_details
varchar(255)
YES
0
header_row
mediumtext
YES
NULL
hxl_meta_data_id
int(11)
YES
UNI
NULL
include_hxl
tinyint(1)
NO
0
send_to_browser
tinyint(1)
NO
0
send_to_hdx
tinyint(1)
NO
0
hxl_heading_row
mediumtext
YES
NULL
total_rows
int(11)
YES
NULL
total_batches
int(11)
YES
NULL
form_attribute_hxl_attribute_tag
Field
Type
Null
Key
Default
Extra
id
int(11)
NO
PRI
NULL
auto_increment
form_attribute_id
int(11)
NO
MUL
0
hxl_attribute_id
int(11)
YES
MUL
NULL
hxl_tag_id
int(11)
NO
MUL
0
export_job_id
int(11)
NO
MUL
0
form_attribute
Field
Type
Null
Key
Default
Extra
id
int(11)
NO
PRI
NULL
auto_increment
key
varchar(150)
NO
UNI
NULL
label
varchar(150)
NO
NULL
instructions
text
YES
NULL
input
varchar(30)
NO
text
type
varchar(30)
NO
varchar
required
tinyint(1)
NO
0
default
varchar(150)
YES
NULL
priority
int(11)
NO
MUL
99
options
text
YES
NULL
cardinality
int(11)
NO
1
config
text
YES
NULL
form_stage_id
omt(11)
YES
MUL
NULL
response_private
tinyint(1)
NO
0
description
varchar(255)
YES
NULL
form_roles
Field
Type
Null
Key
Default
Extra
id
int(11)
NO
PRI
NULL
auto_increment
form_id
int(11)
NO
MUL
NULL
role_id
int(11)
NO
MUL
NULL
form_stages
Field
Type
Null
Key
Default
Extra
id
int(11)
NO
PRI
NULL
auto_increment
form_id
int(11)
NO
MUL
NULL
label
varchar(150)
NO
NULL
priority
int(11)
NO
99
icon
varchar(100)
YES
NULL
required
tinyint(1)
NO
0
type
varchar(255)
NO
task
description
varchar(255)
YES
NULL
show_when_published
tinyint(1)
NO
1
task_is_internal_only
tinyint(1)
NO
1
form_stages_posts
Field
Type
Null
Key
Default
Extra
form_stage_id
int(11)
NO
PRI
NULL
post_id
int(11)
NO
PRI
NULL
completed
tinyint(1)
NO
0
forms
Field
Type
Null
Key
Default
Extra
id
int(11)
NO
PRI
NULL
auto_increment
parent_id
int(11)
YES
MUL
NULL
name
varchar(255)
NO
NULL
description
text
YES
NULL
type
varchar(30)
NO
report
created
int(11)
NO
MUL
0
updated
int(11)
YES
MUL
NULL
disabled
tinyint(1)
NO
0
require_approval
tinyint(1)
NO
1
everyone_can_create
tinyint(1)
NO
1
color
varchar(6)
YES
NULL
hide_author
tinyint(1)
NO
0
hide_time
tinyint(1)
NO
0
hide_location
tinyint(1)
NO
0
targeted_survey
tinyint(1)
NO
0
hxl_attribute_type_tag
Field
Type
Null
Key
Default
Extra
id
int(11)
NO
PRI
NULL
auto_increment
form_attribute_type
varchar(255)
NO
0
hxl_tag_id
int(11)
NO
MUL
0
hxl_attributes
Field
Type
Null
Key
Default
Extra
id
int(11)
NO
PRI
NULL
auto_increment
attribute
varchar(255)
NO
UNI
0
description
varchar(255)
NO
0
hxl_license
Field
Type
Null
Key
Default
Extra
id
int(11)
NO
PRI
NULL
auto_increment
name
varchar(255)
NO
MUL
0
link
varchar(255)
NO
0
code
varchar(255)
NO
UNI
0
hxl_meta_data
Field
Type
Null
Key
Default
Extra
id
int(11)
NO
PRI
NULL
auto_increment
private
tinyint(1)
NO
1
dataset_title
varchar(255)
NO
MUL
NULL
license_id
int(11)
NO
MUL
NULL
user_id
int(11)
NO
MUL
NULL
organisation_id
varchar(255)
NO
NULL
source
varchar(255)
NO
NULL
created
int(11)
NO
0
updated
int(11)
YES
NULL
organisation_name
varchar(255)
YES
NULL
hxl_tag_attributes
Field
Type
Null
Key
Default
Extra
tag_id
int(11)
NO
PRI
0
attribute_id
int(11)
NO
PRI
0
hxl_tags
Field
Type
Null
Key
Default
Extra
id
int(11)
NO
PRI
NULL
auto_increment
tag_name
varchar(255)
NO
UNI
0
description
varchar(255)
NO
0
layers
Field
Type
Null
Key
Default
Extra
id
int(11)
NO
PRI
NULL
auto_increment
media_id
int(11)
YES
MUL
NULL
name
varchar(50)
NO
NULL
type
varchar(20)
NO
geojson
data_url
varchar(255)
YES
NULL
options
varchar(255)
YES
NULL
acte
int(1)
NO
1
invisible_by_default
int(1)
NO
1
created
int(11)
NO
MUL
0
updated
int(11)
NO
MUL
0
media
Field
Type
Null