JACoW / Tools / CWS

Home Proceedings Authors Organizers / Editors JACoW Team About Contacts

Conference Website Dynamic Data Inclusions, Conference Tools, and Information Screens

Stefano Deiuri - Elettra-Sincrotrone Trieste S.C.p.A.

This talk will showcase the variety of SPMS generated reports which can be included in your conference website and are automatically updated as data evolves is your SPMS instance.

A number of useful applications for poster police, doting boards, and other information screens will be showcased.

Scheme

In this scheme the CWS server and Web server are separated but in case you manage the website these can also coincide.

Installation

Clone the package to your server (ex. /var/www/html/) with this command

 git clone https://github.com/JACoW-org/CWS.git CWS

To run the scripts you need a web server that support php!

Directory structure

spms_*_importer: importer scripts
app_*: web apps (interactive pages)
page_*: dynamics pages
make_*: scripts that generate static contents
data: data processed and saved by the scripts for next steps
html: output files saved by the scripts
libs: required common libraries
tmp: temporary (raw) data downloaded from the SPMS (cache)

Configuration

The configuration file config.php is available in the root of the package.

Global configuration

Some global parameters shared by the scripts have to be configured in the global section of the configuration file.

 define( 'ROOT_PATH', '/var/www/html/jacow-spms-cws' );

 cws_config =array(
   'global' =>array(
     'conf_name'       =>'IPAC18'
     'conf_url'        =>'http://ipac18.org'
     'spms_url'        =>'https://spms.fnal.gov/pls/ipac18'
     'root_url'        =>'http://ipac18.org/cws'
     'spms_passphrase' =>' see @ SPMS / System parameters / Web configuration page '
     'cws_timezone'    =>'Canada/Pacific'
     'date_start'      =>'2018-04-29'
     'date_end'        =>'2018-05-04'
     ....

Script configuration

Each script has its own section in the configuration file, usually it is not needed to change the default values.

SPMS configuration for Registrants' Chart

Dependency: "Include Registrants on Statistical Reports" flag in the registration page (Registration \ Setup & Maintanance \ Page Layout) properties of the SPMS.

SPMS configuration for Participants Page

Dependency: "Include Registrants on List Of Participants Report" flag in the registration page properties of the SPMS.

Cron

The data into the SPMS are continuously updated so the scripts must be executed periodically.

To simplify this task the package provides the script cron.php that reads the configuration file and executes each script at the right time.

The global setting cron_enabled enables or disables this script.

The cron parameter available in the script section of the configuration file controls when to run it.

Some examples:

 'spms_stats_importer' =>array(
    'cron' => '*:*' // the script is run each minute

 'spms_importer' =>array(
    'cron' => '*:00' // the script is run each hour at minute 00

 'make_chart_registrants' =>array(
    'cron' => '*:05' // the script is run each hour at minute 05, after the new data are imported

to disable the automatic execution of a script, use:

 'cron' => false // the script is not run

Index page

The script index.php available in the root of the package gives you access to the contents of the different scripts.

Charts

These scripts processes data collected from the SPMS and produces two files (HTML and Javascript) to render the chart. (by way of Google API)

Template files are used to simplify the integration with the conference website

Abstracts Submission Chart

 Script: make_chart_abstracts

Papers Submission Chart

 Script: make_chart_papers

Registrants Chart

 Script: make_chart_registrants

Participants Page

 Script: make_page_participants

This page summarizes the data of the recordings, it includes these elements:

chart with the trend of registrations
list of delegates
chart of countries

Programme Page

 Script: make_page_programme

The script produces:

page with the sessions, talks, breaks, for each day of conference
many HTML files, one for each abstract (these files are dynamically loaded in the programme when required)

Day view

Day view - with abstract

Day view - session expanded

Poster Police App

 Script: app_poster_police

This is the only script sending data to the SPMS, for this reason an access password is required, and must be set in the relevant section of the configuration file.

This is a tool to collect information about the posters - needed for the production of the proceedings