Products
Contact Support Additional Learning Monthly Product Updates
Menu

Forsta Surveys Support

All the topics, resources needed for Forsta Surveys.

Panel Management System Fields Integration

  • Last updated:

Articles in this section

In this article

    Panel Management customers are able to access and update their panelists' system field datapoints directly from a Decipher survey using the XML Editor.

    The datapoints will not be displayed in the Datapoint Manager, sample source stage or datasource stage. The questions referencing the datapoints will be visible in the Survey Editor tree.

    Note: System field datapoints can only be added via the survey XML.

    1: System Fields

    The following Panel Management system field datapoints are available within Decipher:

    System Field

    Label

    Question Type

    Value Format
    email sys_email

    text
    joined sys_joined

    text

    YYYY-MM-DD
    subscribed sys_subscribed

    text

    "yes", "no", "unconfirmed"
    source_id sys_source_id

    number
    community_id sys_community_id

    number
    timezone sys_timezone

    text

    See full list
    emailok sys_emailok

    text

    		 "yes", "no"
    phoneok sys_phoneok

    text

    		 "yes", "no"
    language sys_language

    text

    		 mapped decLang value (read only)

    1.1: Available Timezones

    The following are all valid Panel Management timezones:

    • "Africa/Abidjan"
    • "Africa/Accra"
    • "Africa/Addis_Ababa"
    • "Africa/Algiers"
    • "Africa/Asmara"
    • "Africa/Asmera"
    • "Africa/Bamako"
    • "Africa/Bangui"
    • "Africa/Banjul"
    • "Africa/Bissau"
    • "Africa/Blantyre"
    • "Africa/Brazzaville"
    • "Africa/Bujumbura"
    • "Africa/Cairo"
    • "Africa/Casablanca"
    • "Africa/Ceuta"
    • "Africa/Conakry"
    • "Africa/Dakar"
    • "Africa/Dar_es_Salaam"
    • "Africa/Djibouti"
    • "Africa/Douala"
    • "Africa/El_Aaiun"
    • "Africa/Freetown"
    • "Africa/Gaborone"
    • "Africa/Harare"
    • "Africa/Johannesburg"
    • "Africa/Juba"
    • "Africa/Kampala"
    • "Africa/Khartoum"
    • "Africa/Kigali"
    • "Africa/Kinshasa"
    • "Africa/Lagos"
    • "Africa/Libreville"
    • "Africa/Lome"
    • "Africa/Luanda"
    • "Africa/Lubumbashi"
    • "Africa/Lusaka"
    • "Africa/Malabo"
    • "Africa/Maputo"
    • "Africa/Maseru"
    • "Africa/Mbabane"
    • "Africa/Mogadishu"
    • "Africa/Monrovia"
    • "Africa/Nairobi"
    • "Africa/Ndjamena"
    • "Africa/Niamey"
    • "Africa/Nouakchott"
    • "Africa/Ouagadougou"
    • "Africa/Porto-Novo"
    • "Africa/Sao_Tome"
    • "Africa/Timbuktu"
    • "Africa/Tripoli"
    • "Africa/Tunis"
    • "Africa/Windhoek"
    • "America/Adak"
    • "America/Anchorage"
    • "America/Anguilla"
    • "America/Antigua"
    • "America/Araguaina"
    • "America/Argentina/Buenos_Aires"
    • "America/Argentina/Catamarca"
    • "America/Argentina/ComodRivadavia"
    • "America/Argentina/Cordoba"
    • "America/Argentina/Jujuy"
    • "America/Argentina/La_Rioja"
    • "America/Argentina/Mendoza"
    • "America/Argentina/Rio_Gallegos"
    • "America/Argentina/Salta"
    • "America/Argentina/San_Juan"
    • "America/Argentina/San_Luis"
    • "America/Argentina/Tucuman"
    • "America/Argentina/Ushuaia"
    • "America/Aruba"
    • "America/Asuncion"
    • "America/Atikokan"
    • "America/Atka"
    • "America/Bahia"
    • "America/Bahia_Banderas"
    • "America/Barbados"
    • "America/Belem"
    • "America/Belize"
    • "America/Blanc-Sablon"
    • "America/Boa_Vista"
    • "America/Bogota"
    • "America/Boise"
    • "America/Buenos_Aires"
    • "America/Cambridge_Bay"
    • "America/Campo_Grande"
    • "America/Cancun"
    • "America/Caracas"
    • "America/Catamarca"
    • "America/Cayenne"
    • "America/Cayman"
    • "America/Chicago"
    • "America/Chihuahua"
    • "America/Coral_Harbour"
    • "America/Cordoba"
    • "America/Costa_Rica"
    • "America/Creston"
    • "America/Cuiaba"
    • "America/Curacao"
    • "America/Danmarkshavn"
    • "America/Dawson"
    • "America/Dawson_Creek"
    • "America/Denver"
    • "America/Detroit"
    • "America/Dominica"
    • "America/Edmonton"
    • "America/Eirunepe"
    • "America/El_Salvador"
    • "America/Ensenada"
    • "America/Fortaleza"
    • "America/Fort_Wayne"
    • "America/Glace_Bay"
    • "America/Godthab"
    • "America/Goose_Bay"
    • "America/Grand_Turk"
    • "America/Grenada"
    • "America/Guadeloupe"
    • "America/Guatemala"
    • "America/Guayaquil"
    • "America/Guyana"
    • "America/Halifax"
    • "America/Havana"
    • "America/Hermosillo"
    • "America/Indiana/Indianapolis"
    • "America/Indiana/Knox"
    • "America/Indiana/Marengo"
    • "America/Indiana/Petersburg"
    • "America/Indiana/Tell_City"
    • "America/Indiana/Vevay"
    • "America/Indiana/Vincennes"
    • "America/Indiana/Winamac"
    • "America/Indianapolis"
    • "America/Inuvik"
    • "America/Iqaluit"
    • "America/Jamaica"
    • "America/Jujuy"
    • "America/Juneau"
    • "America/Kentucky/Louisville"
    • "America/Kentucky/Monticello"
    • "America/Knox_IN"
    • "America/Kralendijk"
    • "America/La_Paz"
    • "America/Lima"
    • "America/Los_Angeles"
    • "America/Louisville"
    • "America/Lower_Princes"
    • "America/Maceio"
    • "America/Managua"
    • "America/Manaus"
    • "America/Marigot"
    • "America/Martinique"
    • "America/Matamoros"
    • "America/Mazatlan"
    • "America/Mendoza"
    • "America/Menominee"
    • "America/Merida"
    • "America/Metlakatla"
    • "America/Mexico_City"
    • "America/Miquelon"
    • "America/Moncton"
    • "America/Monterrey"
    • "America/Montevideo"
    • "America/Montreal"
    • "America/Montserrat"
    • "America/Nassau"
    • "America/New_York"
    • "America/Nipigon"
    • "America/Nome"
    • "America/Noronha"
    • "America/North_Dakota/Beulah"
    • "America/North_Dakota/Center"
    • "America/North_Dakota/New_Salem"
    • "America/Ojinaga"
    • "America/Panama"
    • "America/Pangnirtung"
    • "America/Paramaribo"
    • "America/Phoenix"
    • "America/Port-au-Prince"
    • "America/Porto_Acre"
    • "America/Porto_Velho"
    • "America/Port_of_Spain"
    • "America/Puerto_Rico"
    • "America/Rainy_River"
    • "America/Rankin_Inlet"
    • "America/Recife"
    • "America/Regina"
    • "America/Resolute"
    • "America/Rio_Branco"
    • "America/Rosario"
    • "America/Santarem"
    • "America/Santa_Isabel"
    • "America/Santiago"
    • "America/Santo_Domingo"
    • "America/Sao_Paulo"
    • "America/Scoresbysund"
    • "America/Shiprock"
    • "America/Sitka"
    • "America/St_Barthelemy"
    • "America/St_Johns"
    • "America/St_Kitts"
    • "America/St_Lucia"
    • "America/St_Thomas"
    • "America/St_Vincent"
    • "America/Swift_Current"
    • "America/Tegucigalpa"
    • "America/Thule"
    • "America/Thunder_Bay"
    • "America/Toronto"
    • "America/Tortola"
    • "America/Vancouver"
    • "America/Virgin"
    • "America/Whitehorse"
    • "America/Winnipeg"
    • "America/Yakutat"
    • "America/Yellowknife"
    • "Antarctica/Casey"
    • "Antarctica/Davis"
    • "Antarctica/DumontDUrville"
    • "Antarctica/Macquarie"
    • "Antarctica/Mawson"
    • "Antarctica/McMurdo"
    • "Antarctica/Palmer"
    • "Antarctica/Rothera"
    • "Antarctica/South_Pole"
    • "Antarctica/Syowa"
    • "Antarctica/Troll"
    • "Antarctica/Vostok"
    • "Arctic/Longyearbyen"
    • "Asia/Aden"
    • "Asia/Almaty"
    • "Asia/Amman"
    • "Asia/Anadyr"
    • "Asia/Aqtau"
    • "Asia/Aqtobe"
    • "Asia/Ashgabat"
    • "Asia/Ashkhabad"
    • "Asia/Baghdad"
    • "Asia/Bahrain"
    • "Asia/Baku"
    • "Asia/Bangkok"
    • "Asia/Beirut"
    • "Asia/Bishkek"
    • "Asia/Brunei"
    • "Asia/Calcutta"
    • "Asia/Chita"
    • "Asia/Choibalsan"
    • "Asia/Chongqing"
    • "Asia/Chungking"
    • "Asia/Colombo"
    • "Asia/Dacca"
    • "Asia/Damascus"
    • "Asia/Dhaka"
    • "Asia/Dili"
    • "Asia/Dubai"
    • "Asia/Dushanbe"
    • "Asia/Gaza"
    • "Asia/Harbin"
    • "Asia/Hebron"
    • "Asia/Hong_Kong"
    • "Asia/Hovd"
    • "Asia/Ho_Chi_Minh"
    • "Asia/Irkutsk"
    • "Asia/Istanbul"
    • "Asia/Jakarta"
    • "Asia/Jayapura"
    • "Asia/Jerusalem"
    • "Asia/Kabul"
    • "Asia/Kamchatka"
    • "Asia/Karachi"
    • "Asia/Kashgar"
    • "Asia/Kathmandu"
    • "Asia/Katmandu"
    • "Asia/Khandyga"
    • "Asia/Kolkata"
    • "Asia/Krasnoyarsk"
    • "Asia/Kuala_Lumpur"
    • "Asia/Kuching"
    • "Asia/Kuwait"
    • "Asia/Macao"
    • "Asia/Macau"
    • "Asia/Magadan"
    • "Asia/Makassar"
    • "Asia/Muscat"
    • "Asia/Nicosia"
    • "Asia/Novokuznetsk"
    • "Asia/Novosibirsk"
    • "Asia/Omsk"
    • "Asia/Oral"
    • "Asia/Phnom_Penh"
    • "Asia/Pontianak"
    • "Asia/Pyongyang"
    • "Asia/Qatar"
    • "Asia/Qyzylorda"
    • "Asia/Rangoon"
    • "Asia/Riyadh"
    • "Asia/Saigon"
    • "Asia/Sakhalin"
    • "Asia/Seoul"
    • "Asia/Shanghai"
    • "Asia/Singapore"
    • "Asia/Srednekolymsk"
    • "Asia/Taipei"
    • "Asia/Tashkent"
    • "Asia/Tbilisi"
    • "Asia/Tehran"
    • "Asia/Tel_Aviv"
    • "Asia/Thimbu"
    • "Asia/Tokyo"
    • "Asia/Ujung_Pandang"
    • "Asia/Ulaanbaatar"
    • "Asia/Ulan_Bator"
    • "Asia/Urumqi"
    • "Asia/Ust-Nera"
    • "Asia/Vientiane"
    • "Asia/Vladivostok"
    • "Asia/Yakutsk"
    • "Asia/Yekaterinburg"
    • "Asia/Yerevan"
    • "Atlantic/Azores"
    • "Atlantic/Bermuda"
    • "Atlantic/Canary"
    • "Atlantic/Cape_Verde"
    • "Atlantic/Faeroe"
    • "Atlantic/Faroe"
    • "Atlantic/Jan_Mayen"
    • "Atlantic/Madeira"
    • "Atlantic/Reykjavik"
    • "Atlantic/South_Georgia"
    • "Atlantic/Stanley"
    • "Atlantic/St_Helena"
    • "Australia/ACT"
    • "Australia/Adelaide"
    • "Australia/Brisbane"
    • "Australia/Broken_Hill"
    • "Australia/Canberra"
    • "Australia/Currie"
    • "Australia/Darwin"
    • "Australia/Eucla"
    • "Australia/Hobart"
    • "Australia/LHI"
    • "Australia/Lindeman"
    • "Australia/Lord_Howe"
    • "Australia/Melbourne"
    • "Australia/North"
    • "Australia/NSW"
    • "Australia/Perth"
    • "Australia/Queensland"
    • "Australia/South"
    • "Australia/Sydney"
    • "Australia/Tasmania"
    • "Australia/Victoria"
    • "Australia/West"
    • "Australia/Yancowinna"
    • "Brazil/Acre"
    • "Brazil/DeNoronha"
    • "Brazil/East"
    • "Brazil/West"
    • "Canada/Atlantic"
    • "Canada/Central"
    • "Canada/East-Saskatchewan"
    • "Canada/Eastern"
    • "Canada/Mountain"
    • "Canada/Newfoundland"
    • "Canada/Pacific"
    • "Canada/Saskatchewan"
    • "Canada/Yukon"
    • "CET"
    • "Chile/Continental"
    • "Chile/EasterIsland"
    • "CST6CDT"
    • "Cuba"
    • "EET"
    • "Egypt"
    • "Eire"
    • "EST"
    • "EST5EDT"
    • "Etc/GMT"
    • "Etc/GMT+0"
    • "Etc/GMT+1"
    • "Etc/GMT+10"
    • "Etc/GMT+11"
    • "Etc/GMT+12"
    • "Etc/GMT+2"
    • "Etc/GMT+3"
    • "Etc/GMT+4"
    • "Etc/GMT+5"
    • "Etc/GMT+6"
    • "Etc/GMT+7"
    • "Etc/GMT+8"
    • "Etc/GMT+9"
    • "Etc/GMT-0"
    • "Etc/GMT-1"
    • "Etc/GMT-10"
    • "Etc/GMT-11"
    • "Etc/GMT-12"
    • "Etc/GMT-13"
    • "Etc/GMT-14"
    • "Etc/GMT-2"
    • "Etc/GMT-3"
    • "Etc/GMT-4"
    • "Etc/GMT-5"
    • "Etc/GMT-6"
    • "Etc/GMT-7"
    • "Etc/GMT-8"
    • "Etc/GMT-9"
    • "Etc/GMT0"
    • "Etc/Greenwich"
    • "Etc/UCT"
    • "Etc/Universal"
    • "Etc/UTC"
    • "Etc/Zulu"
    • "Europe/Amsterdam"
    • "Europe/Andorra"
    • "Europe/Athens"
    • "Europe/Belfast"
    • "Europe/Belgrade"
    • "Europe/Berlin"
    • "Europe/Bratislava"
    • "Europe/Brussels"
    • "Europe/Bucharest"
    • "Europe/Budapest"
    • "Europe/Busingen"
    • "Europe/Chisinau"
    • "Europe/Copenhagen"
    • "Europe/Dublin"
    • "Europe/Gibraltar"
    • "Europe/Guernsey"
    • "Europe/Helsinki"
    • "Europe/Isle_of_Man"
    • "Europe/Istanbul"
    • "Europe/Jersey"
    • "Europe/Kaliningrad"
    • "Europe/Kiev"
    • "Europe/Lisbon"
    • "Europe/Ljubljana"
    • "Europe/London"
    • "Europe/Luxembourg"
    • "Europe/Madrid"
    • "Europe/Malta"
    • "Europe/Mariehamn"
    • "Europe/Minsk"
    • "Europe/Monaco"
    • "Europe/Moscow"
    • "Europe/Nicosia"
    • "Europe/Oslo"
    • "Europe/Paris"
    • "Europe/Podgorica"
    • "Europe/Prague"
    • "Europe/Riga"
    • "Europe/Rome"
    • "Europe/Samara"
    • "Europe/San_Marino"
    • "Europe/Sarajevo"
    • "Europe/Simferopol"
    • "Europe/Skopje"
    • "Europe/Sofia"
    • "Europe/Stockholm"
    • "Europe/Tallinn"
    • "Europe/Tirane"
    • "Europe/Tiraspol"
    • "Europe/Uzhgorod"
    • "Europe/Vaduz"
    • "Europe/Vatican"
    • "Europe/Vienna"
    • "Europe/Vilnius"
    • "Europe/Volgograd"
    • "Europe/Warsaw"
    • "Europe/Zagreb"
    • "Europe/Zaporozhye"
    • "Europe/Zurich"
    • "GB"
    • "GB-Eire"
    • "GMT"
    • "GMT+0"
    • "GMT-0"
    • "GMT0"
    • "Greenwich"
    • "Hongkong"
    • "HST"
    • "Iceland"
    • "Indian/Antananarivo"
    • "Indian/Chagos"
    • "Indian/Christmas"
    • "Indian/Cocos"
    • "Indian/Comoro"
    • "Indian/Kerguelen"
    • "Indian/Mahe"
    • "Indian/Maldives"
    • "Indian/Mauritius"
    • "Indian/Mayotte"
    • "Indian/Reunion"
    • "Iran"
    • "Israel"
    • "Jamaica"
    • "Japan"
    • "Kwajalein"
    • "Libya"
    • "MET"
    • "Mexico/BajaNorte"
    • "Mexico/BajaSur"
    • "Mexico/General"
    • "MST"
    • "MST7MDT"
    • "Navajo"
    • "NZ"
    • "NZ-CHAT"
    • "Pacific/Apia"
    • "Pacific/Auckland"
    • "Pacific/Bougainville"
    • "Pacific/Chatham"
    • "Pacific/Chuuk"
    • "Pacific/Easter"
    • "Pacific/Efate"
    • "Pacific/Enderbury"
    • "Pacific/Fakaofo"
    • "Pacific/Fiji"
    • "Pacific/Funafuti"
    • "Pacific/Galapagos"
    • "Pacific/Gambier"
    • "Pacific/Guadalcanal"
    • "Pacific/Guam"
    • "Pacific/Honolulu"
    • "Pacific/Johnston"
    • "Pacific/Kiritimati"
    • "Pacific/Kosrae"
    • "Pacific/Kwajalein"
    • "Pacific/Majuro"
    • "Pacific/Marquesas"
    • "Pacific/Midway"
    • "Pacific/Nauru"
    • "Pacific/Niue"
    • "Pacific/Norfolk"
    • "Pacific/Noumea"
    • "Pacific/Pago_Pago"
    • "Pacific/Palau"
    • "Pacific/Pitcairn"
    • "Pacific/Pohnpei"
    • "Pacific/Ponape"
    • "Pacific/Port_Moresby"
    • "Pacific/Saipan"
    • "Pacific/Samoa"
    • "Pacific/Tahiti"
    • "Pacific/Tarawa"
    • "Pacific/Tongatapu"
    • "Pacific/Truk"
    • "Pacific/Wake"
    • "Pacific/Wallis"
    • "Pacific/Yap"
    • "Poland"
    • "Portugal"
    • "posixrules"
    • "PRC"
    • "PST8PDT"
    • "ROC"
    • "ROK"
    • "Singapore"
    • "Turkey"
    • "UCT"
    • "Universal"
    • "US/Alaska"
    • "US/Aleutian"
    • "US/Arizona"
    • "US/Central"
    • "US/East-Indiana"
    • "US/Eastern"
    • "US/Hawaii"
    • "US/Indiana-Starke"
    • "US/Michigan"
    • "US/Mountain"
    • "US/Pacific"
    • "US/Pacific-New"
    • "US/Samoa"
    • "UTC"
    • "W-SU"
    • "WET"
    • "Zulu"

    2: Adding System Fields

    To add Panel Management system field datapoints, you will first need to add their matching question type to an existing datasource in your survey via the XML Editor. Then, you will need to add a hidden survey question and XML <exec> tag to pass participant's system field values back to Panel Management.

    2.1: Adding the Datapoints

    In the XML Editor, add your Panel Management datapoint as a question. The datapoint question should be optional, with the label being the value of the kinesis:dpl and dataRef fields.

    If you need to include multiple Panel Management datapoints in your survey, you can add these to a single datasource. For example, you could use the following code to add the timezone, source ID, and community ID datapoints to your survey:

    <datasource label="ds1" builder:title="[Panel Name]" datasourceKey="panelist_hash" filename="@kinesis" kinesis:pid="167" kinesis:url="[instance URL]" normalizeKey="none" ourKey="panelist_hash" where="execute,survey,report">
  <text 
   label="ds1_dp_sys_timezone"
   dataRef="sys_timezone"
   dataSource="ds1"
   kinesis:dpl="sys_timezone"
   where="execute,survey,report">
    <title>Timezone</title>
  </text>

  <number 
   label="ds1_dp_sys_source_id"
   dataRef="sys_source_id"
   dataSource="ds1"
   kinesis:dpl="sys_source_id"
   size="10"
   where="execute,survey,report">
    <title>Recruitment Source</title>
  </number>

  <number 
   label="ds1_dp_sys_community_id"
   dataRef="sys_community_id"
   dataSource="ds1"
   kinesis:dpl="sys_community_id"
   size="10"
   where="execute,survey,report">
    <title>Community</title>
  </number>
</datasource>

    Note:  Datasources for other datapoints can also be added in the Survey Editor and the associated panel information will be added to the <datasource> tag. See Pulling Panel Management Datapoints into a Decipher Survey to learn more about pulling regular Panel Management datapoints into a survey.

    2.2: Adding the Survey Elements

    Once you have added your datapoints, you will need to add a hidden question and <exec> tag to make the datapoints editable. First, add a question outside of the datasource for the datapoint you would like to alter; you can choose whether to display or hide this question from participants using the where attribute.

    Then, add an <exec> tag to define the survey or report logic for updating the datapoint.

    For example, you could use the following code to change the timezone value based on the timezone users have when they enter the survey:

    <exec>
ds1_sys_timezone.val = qtimezone.val + 1
</exec>

<text 
  label="ds1_sys_timezone"
  dataRef="sys_timezone"
  dataSource="ds1"
  kinesis:dpl="sys_timezone"
  where="execute,survey,report">
  <title>Timezone</title>
</text>

    Similarly, you could add the following code to set the community ID for participants based on their country, as selected in the survey (in this example, the user's country would be the value they selected at q1):

    <exec>
if q1.val lt 3:
    ds1_sys_community_id.val = q1.val + 1
elif q1.val == q1.r5.index:
    ds1_sys_community_id.val = 2
else:
    ds1_sys_community_id.val = 1
</exec>

<number 
  label="ds1_sys_community_id"
  dataRef="sys_community_id"
  dataSource="ds1"
  kinesis:dpl="sys_community_id"
  size="10"
  where="execute,survey,report">
  <title>Community</title>
</number>

    Note:  Blank values are ignored and not sent back to Panel Management. This means that you can’t unset a value for source_id or timezone from your survey. If you would like to unset a value from your survey, you would need to deselect it within Panel Management. Like datapoints, invalid system field values will result in errors being emailed to project subscribers without preventing the participant from completing.

    Was this article helpful?
    0 out of 0 found this helpful
    Return to top