Data Extracts Procedures

In this section all the procedures to extract data from the SPMS for external use are described. This data could be put directly on the website, such as for the list of participants, or used to create graphs, such as for when abstracts are being submitted.

Every procedure here described can be called by using a URL formatted like this:

  https://RSC_ADDR/PLSNAME/Xtract.PROCEDURE

where:

  • RSC_ADDR is the address (name or IP) of the regional support center server.
  • PLSNAME is the PLS name of your conference instance.
  • PROCEDURE is one of the procedures described below.

If any parameter is needed, those must be specified as a GET parameter passing, as usual, like

  https://RSC_ADDR/PLSNAME/Xtract.PROCEDURE?PARAM1=VALUE1&PARAM2=VALUE2...

Some procedures always furnish their output, others are protected by a password set in SPMS (System Parameters | Web Configuration | Secret Passphrase for automated data extracts). In the latter case, only if a correct chk=secret_passphrase parameter will be used.

All the procedures usually extract data in comma separated values (CSV) format.

When dates are concerned, ISO format is used (YYYY-MM-DD).

If a line begins with a hash (#), it's a comment.

Registration Statistics

Name: regstats

This procedure extracts a list of values (number of people that registered) related to a date (when they registered). A single letter is added as a third character, meaning "regular delegates" (D) or "sponsored delegates" (S).

Parameters

None

Dependency

The "Include in participants report" flag must be set (in the Registration Page Properties) page.

Example

  2011-04-14, 1, D
  2011-04-18, 215, D
  2011-09-04, 1, D

List of Participants (LoP)

Name: attendees

This procedure extracts a list of registered persons together with their main affiliation name and Country.
A single letter is added as a fifth character, meaning "regular delegates" (D) or "sponsored delegates" (S).

Parameters

None

Dependency

"Include in participants report" flag must be set (in the Registration Page Properties) page.

Example

  "Brown","John","University of Nowhere","Atlantis","S"
  "Koenig","John","NASA","USA","D"
  "Straker","Ed","SHADO (Supreme Headquarters Alien Defence Organization)","UK","D"

Most important conference dates

Name: dates

Commonly used to have consistent data on the website. The data comes from the SPMS system parameters and should be self-explanatory.

Every line consists of a label, descriptive of the date, and the date.

Parameters

  • chk - Secret Passphrase for automated data extracts (from SPMS system parameters)

Dependency

None

Example

  #dates:begin
  conference_start, 2013-09-29
  conference_end, 2013-10-05
  #dates:end

Abstracts submission statistics (per day)

Name: abstractsubmissions

An ordered pair of dates and number of abstracts created that day.

Parameters

  • chk - Secret Passphrase for automated data extracts (from SPMS System Parameters)

Dependency

None

Example

	#abstractsubmissions:begin
	2010-05-26, 1
	2010-05-27, 2
	2010-05-28, 3
	2010-05-29, 1
	2010-06-04, 3
	2010-06-06, 5
	2010-06-07, 2
	2010-06-09, 1
	2010-06-23, 2
	2010-06-24, 3
	2010-06-28, 1
	2010-06-29, 1
	2010-06-30, 2
	2010-07-04, 1
	2010-07-06, 5
	2012-02-06, 1
	#abstractsubmissions:end

Uploaded files (per day)

Name: filesuploaded

An ordered pair of dates and number of files/contributions uploaded per day.

The result could depend on the what parameter value.

Parameters

  • chk - Secret Passphrase for automated data extracts (from SPMS system parameters)
  • what - Type of statistic. Values are:
    • papercode (default) - number of contributions (first) uploaded
      in this case, in the comment part, the total number of papers/abstracts that can be uploaded is also given.

Dependency

None

Example

  #filesuploaded_papercode:begin
  #total_abstracts:1205
  2010-05-29, 1
  2010-06-04, 3
  2010-06-06, 5
  2010-06-07, 2
  #filesuploaded_papercode:end

Reserved booth status (industrial registration)

Name: getBoothStatus

This procedure gives out a sequence of values already taken from a meta data code of type Checkboxes. The values are those that have been taken/selected/reserved.

Both the Poplist item ID and value are produced, separated by a semicolon.

Parameters

  • chk - Secret Passphrase for automated data extracts (from SPMS system parameters)
  • mdc - Meta Data Code ID (numeric)

Dependency

An item with correct data type and values must have been created and configured in the SPMS Registration setup and maintenance. The Meta Data Code ID can be found by looking at the URL of the SPMS page when editing the desired Data Field.

Example Output

  120;Booth No. 63 
  121;Booth No. 64 
  122;Booth No. 65 
  123;Booth No. 66
  124;Booth No. 67 
  125;Booth No. 68 
  126;Booth No. 69