Working with ShakeCast A Training Manual

Contents  Module 1: Introduction to key concepts  Module 2: ShakeCast installation  Module 3: System configuration  Module 4: Inventory and database management  Module 5: System maintenance  Module 6: Tweaks and tricks

Module 1 ShakeCast Key Concepts  ShakeCast Background  ShakeCast technology  Where can ShakeCast be used?  ShakeCast implementations (Full, Lite, Remote, and Preview)  ShakeCast V3.0

ShakeCast Data Flow

ShakeCast System from User’s Perspective

ShakeCast technology  ShakeMap RSS data feed (XML)  Apache and PHP web server  MySQL database server  Perl scripts  Google Maps

ShakeCast System Components ShakeCast Database RSS Service Dispatcher Service Polling Service Notification Queuing Service Notification Delivery Service Web Service 7 Receive/Process ShakeMaps from designated ShakeMap Servers, USGS Handle requests from other ShakeCast servers Poll information from other ShakeCast servers Prepare user notification messages, who and what Deliver ShakeCast user notifications

Where can ShakeCast be used?  Where ShakeMap is produced  Globally magnitude of 5.5 or greater  Regions inside the U.S., magnitude of ~3.5 or greater

ShakeMap Regions NCSC NN US

ShakeCast implementations  Full: Full ShakeCast application  Lite: ShakeMap RSS reader  Remote: ShakeCast hosting by USGS Fort Collins  Preview: Standalone ShakeCast system

Module 2 ShakeCast Installation  ShakeCast installer  System requirement  Manual installation procedure  Common issues and fixes

ShakeCast installer  Official support for MS Windows operating system  Linux, UNIX, and Mac OS X (BSD) variants available  Clean (full) installation will wipe out existing database and system settings  Try rerun the installer if it did not finish the process on the first run

System requirement  Hardware: typical P4 or equivalent desktop or server setup  Software: MS Windows 2000/XP/Vista/7/Server  Network: access to the Internet and SMTP server

Let’s Try It  ShakeCast Preview is your friend Probe your system and IT environmentProbe your system and IT environment Gauge real world performanceGauge real world performance

Manual installation procedure  Prerequisite software PerlPerl ApacheApache MySQLMySQL PHPPHP  ShakeCast software  Post-installation tools

Post-installation tools (admin directory)

Common issues and fixes  Installer encountered errors and quit  Post installation scripts failed  Installation process completed, then what?  ShakeCast system services not running  No ShakeCast web interface  This doesn’t end…

Module 3: System Configuration  Post installation configuration  System services  SMTP mail server  Apache web server  MySQL database server  Perl and PHP

Post installation configuration  System check/config tools  ShakeCast database  System services  Config directory and files  Log directory and files

System services  Five ShakeCast services  Apache service  MySQL service  Install/remove services  Start/stop services

SMTP mail server  You really need help from your IT department  Most notifications are sent via mail server, except script notifications  Basic authentication  Two entries in the system, one in sc.conf and one in database

Apache web server  Apache config files are not exchangeable among different versions  ShakeCast specific add-on httpd- sc.conf  Combined access and error logs  Apache and PHP  Service control

MySQL database server  ShakeCast database directory  MySQL.ini file  Error and slow-query logs  Service control  User authentication

Perl and PHP  Perl and PHP installation directories and system environment settings  Perl modules and PPM Default modulesDefault modules Optional and third-party modulesOptional and third-party modules ShakeCast custom modulesShakeCast custom modules  PHP extensions  PHP, Apache, and MySQL connectors

Module 4: Inventory and Database Management  Facility Management  Profile Management  User Management  Notification Requests  Processing ShakeMaps

Facility Management  Required information of facility  Unique facility ID  Custom facility type  Fragility settings  Volume import of facilities

ShakeCast Facility Table

Facility Type Table

Facility Fragility Table

Profile Management  A profile is a notification template  Geometry boundaries  Facility type filter  Profile notification requests

Profile Definition File  Uses Apache general config format  Allows multiple profile definitions per file

User Management  Required information of a user  Delivery methods of notifications  User-profile association  User notification replication  Volume import of user profiles

Required User Information  Username  Password  User type  At least one address

Notification Requests  Use profile whenever possible  Requests are explicit  Request aggregation  Notifications and ShakeMap metrics  Delivery methods and addresses  Notification templates

Processing ShakeMaps  ShakeCast automatic processes  Processed ShakeMap data directory  Procedure for processing ShakeMaps manually  Be careful with ShakeMap event types

ShakeCast Automatic Process  ShakeMap RSS data polling interval (2 min.)  ShakeMap region filter  Active time window  Re-trigger threshold (% changes)

Data Directory and Event Type  Processed ShakeMap directory ~/sc/data~/sc/data ~/sc/test_data~/sc/test_data  Event type ActualActual ScenarioScenario Test (ShakeCast only)Test (ShakeCast only)

Manual ShakeMap Processing  Filter directives for automatic processing are not applicable  ShakeMaps with Actual event types will be treated as real events  Previously processed ShakeMaps will be skipped

Module 5: System Maintenance  Inventory update  Database maintenance  System function test  System logs

Inventory Update  Order of inventory update: facility, profile, then user  Updating inventory has different scope of impact  Insert, update, replace, and delete  Prepare inventory data in csv files to speed up the process

Database Maintenance  Spot performance issues with slow query logs  Delete unwanted ShakeMaps  Database backup/restore  Rebuild ShakeCast database  Synchronize configuration information between database and sc.conf

System Function Tests  ShakeCast heartbeat test  Initiate local test events  Process ShakeMaps from USGS web site  Schedule routine tests

System Logs  Finding and rotating log files  ShakeCast service logging level  Identify abnormal activities  When to look for help?

Module 6: Tweaks and Tricks  Custom web page and Google Maps  Notification template  Script template  Local ShakeCast product  Server Redundancy

Custom Web Page and Google Maps  Web page template and image sets  Facility type markers for Google Maps  Default map center and zoom level  phpMyAdmin  Version 1 administrative interface and access control

Notification Template  Short, long, and content rich messages  Notification template anatomy  Default notification templates  Template keywords

Script Template  Use this option only when static template doesn't work  Consider the option of local product  Script template can be use to launch any command line executable  Voice notification example

Local ShakeCast Product  Uses new template engine (template toolkit bundle)  Template setup  Product generation and access  Examples

Server Redundancy  Upstream ShakeMap servers  ShakeCast server-server communications  NEIC ShakeCast backup server