Actions

Proposed Universal Substitution System: Difference between revisions

From Convention Master Documentation

No edit summary
 
(26 intermediate revisions by the same user not shown)
Line 1: Line 1:
{| class="wikitable"
=== General Idea ===
|+ Caption text
CM has a bunch of variable lookup systems, it would be helpful to combine these into one system.
|-
! Header text !! Header text !! Header text
|-
| Example || Example || Example
|-
| Example || Example || Example
|-
| Example || Example || Example
|}


This article is still a stub.


{| class="wikitable"
{| class="wikitable"
Line 19: Line 11:
| align="center" style="background:#f0f0f0;"|'''Tag Replacement'''
| align="center" style="background:#f0f0f0;"|'''Tag Replacement'''
| align="center" style="background:#f0f0f0;"|'''badgecode'''
| align="center" style="background:#f0f0f0;"|'''badgecode'''
| align="center" style="background:#f0f0f0;"|'''Notes'''
|-
|-
| uid||outputs the registrant uid.||Tag Replacements||reg_uid||$uid
| uid||outputs the registrant uid.||Tag Replacements||reg_uid||$uid|||
|-
|-
| legal_first||outputs registrant first name.  ||Tag Replacements||reg_rl_first||$registrant_rl_first
| legal_first||outputs registrant first name.  ||Tag Replacements||reg_rl_first||$registrant_rl_first|||
|-
|-
| legal_last||outputs registrant last name.  ||Tag Replacements||reg_rl_last||$registrant_rl_last
| legal_last||outputs registrant last name.  ||Tag Replacements||reg_rl_last||$registrant_rl_last|||
|-
|-
| legal_name||outputs registrant "first" + "last" name.  ||Tag Replacements||reg_full_name||
| legal_name||outputs registrant "first" + "last" name.  ||Tag Replacements||reg_full_name||||
|-
|-
| common_name||outputs registrant badge name if not empty - otherwise thier  "first" + "last" name.  ||Tag Replacements||reg_badge_name||$registrant_fan_name
| common_name||outputs registrant badge name if not empty - otherwise thier  "first" + "last" name.  ||Tag Replacements||reg_badge_name||$registrant_fan_name|||
|-
|-
| badge_name||outputs registrant badge name.  ||Tag Replacements||reg_birthday||$registrant_birthday
| badge_name||outputs registrant badge name.  ||Tag Replacements||reg_birthday||$registrant_birthday|||
|-
|-
| birthday||outputs registrant birthdate.  ||Tag Replacements||reg_first_created||
| birthday||outputs registrant birthdate.  ||Tag Replacements||reg_first_created||||
|-
|-
| first_created||outputs registrant account creation date from database.  ||Tag Replacements||reg_common_name||$registrant_common_name
| first_created||outputs registrant account creation date from database.  ||Tag Replacements||reg_common_name||$registrant_common_name|||
|-
|-
| address_ship_to_name||outputs registrant ship to name.  ||Tag Replacements||reg_address_ship_to_name||
| address_ship_to_name||outputs registrant ship to name.  ||Tag Replacements||reg_address_ship_to_name||||
|-
|-
| address_line_1||outputs registrant address line 1.  ||Tag Replacements||reg_address_line_1||
| address_line_1||outputs registrant address line 1.  ||Tag Replacements||reg_address_line_1||||
|-
|-
| address_line_2||outputs registrant address line 2.  ||Tag Replacements||reg_address_line_2||
| address_line_2||outputs registrant address line 2.  ||Tag Replacements||reg_address_line_2||||
|-
|-
| address_city||outputs registrant address city.  ||Tag Replacements||reg_address_city||
| address_city||outputs registrant address city.  ||Tag Replacements||reg_address_city||||
|-
|-
| address_state||outputs registrant address state. ||Tag Replacements||reg_address_state||
| address_state||outputs registrant address state. ||Tag Replacements||reg_address_state||||
|-
|-
| address_country||outputs registrant address country.  ||Tag Replacements||reg_address_country||
| address_country||outputs registrant address country.  ||Tag Replacements||reg_address_country||||
|-
|-
| address_zip||outputs registrant address zip.  ||Tag Replacements||reg_address_zip||
| address_postcode||outputs registrant address zip/postcode.  ||Tag Replacements||reg_address_zip||||
|-
|-
| address_full||outputs registrant address with all fields combined.  ||Tag Replacements||reg_address_full||
| address_full||outputs registrant address with all fields combined.  ||Tag Replacements||reg_address_full||||
|-
|-
| phone_type||outputs registrant phone type.  ||Tag Replacements||reg_phone_type||
| phone_type||outputs registrant phone type.  ||Tag Replacements||reg_phone_type||||
|-
|-
| phone_number||outputs registrant phone number.  ||Tag Replacements||reg_phone_number||
| phone_number||outputs registrant phone number.  ||Tag Replacements||reg_phone_number||||
|-
|-
| email||outputs registrant email.  ||Tag Replacements||reg_email||
| email||outputs registrant email.  ||Tag Replacements||reg_email||||
|-
|-
| payment_hold_created||outputs date payment hold was created for current registrant and event.  ||Tag Replacements||reg_payment_hold_created||
| payment_hold_created||outputs date payment hold was created for current registrant and event.  ||Tag Replacements||reg_payment_hold_created||||
|-
|-
| payment_hold_expiry||outputs date payment hold will expire for current registrant and event. ex: 2020-01-22 18:30:15  ||Tag Replacements||reg_payment_hold_expiry||
| payment_hold_expiry||outputs date payment hold will expire for current registrant and event. ex: 2020-01-22 18:30:15  ||Tag Replacements||reg_payment_hold_expiry||||
|-
|-
| payment_hold_extendable_to||outputs latest date payment hold can be extended up to for current registrant and event.  ||Tag Replacements||reg_payment_hold_extendable_to||
| payment_hold_extendable_to||outputs latest date payment hold can be extended up to for current registrant and event.  ||Tag Replacements||reg_payment_hold_extendable_to||||
|-
|-
| payment_hold_payment_type||outputs most recent payment type selected for current registrant and event  ||Tag Replacements||reg_payment_hold_payment_type||
| payment_hold_payment_type||outputs most recent payment type selected for current registrant and event  ||Tag Replacements||reg_payment_hold_payment_type||||
|-
|-
| payment_hold_expiry_long||outputs long date payment hold will expire for current registrant and event. ex: Wednesday, January 22, 2020, @ 6:30 PM ||Tag Replacements||reg_payment_hold_expiry_long||
| payment_hold_expiry_long||outputs long date payment hold will expire for current registrant and event. ex: Wednesday, January 22, 2020, @ 6:30 PM ||Tag Replacements||reg_payment_hold_expiry_long||||
|-
|-
| bool_marked_deceased||Returns True if the user is marked deceased||new||||
| bool_marked_deceased||Returns True if the user is marked deceased||new||||||
|-
|-
| bool_ConsoleUser||Returns True if the user has an active console login||new||||
| bool_ConsoleUser||Returns True if the user has an active console login||new||||||
|-
|-
| consoleUserExpiryDate||Displays expiration date for console login||new||||
| consoleUserExpiryDate||Displays expiration date for console login||new||||||
|-
|-
| CompMoneyRemaining||Displays the remaining comp money||new||||
| CompMoneyRemaining||Displays the remaining comp money||new||||||
|}
|}


Line 150: Line 143:
|-
|-
| staff||if attendee_membership_name contains the word 'staff' this will equal true, this is not case sensitive.||badgecode||||$staff||if retained, maybe this should also check membership_long_name
| staff||if attendee_membership_name contains the word 'staff' this will equal true, this is not case sensitive.||badgecode||||$staff||if retained, maybe this should also check membership_long_name
|}
{| class="wikitable"
|+ panelist
| align="center" style="background:#f0f0f0;"|'''Substitution'''
| align="center" style="background:#f0f0f0;"|'''Description'''
| align="center" style="background:#f0f0f0;"|'''Source'''
| align="center" style="background:#f0f0f0;"|'''Tag Replacement'''
| align="center" style="background:#f0f0f0;"|'''badgecode'''
| align="center" style="background:#f0f0f0;"|'''Notes'''
|-
| bool_has_confirmed_activity||useful for a true false for flagging panelist badges.||new||||||This is highly speculative, however I'm presuming this would work something like AS/DD in that the application would be tied to the UID of the person who applied, so we could pick it up that way, it could go into the attendee group
|-
| bool_activity_host||useful for a true false for flagging panelist badges.||new|||||||
|-
| bool_activity_assistant||useful for a true false for flagging panelist badges.||new|||||||
|-
| bool_is_panelist||true if uid matches to either activity host or assistant - useful for a true false for flagging panelist badges.||new|||||||
|-
| activity_schedule||displays a formatted list of activities a panelist is assigned/confirmed to||new|||||||
|}
{| class="wikitable"
|+ dealers
| align="center" style="background:#f0f0f0;"|'''Substitution'''
| align="center" style="background:#f0f0f0;"|'''Description'''
| align="center" style="background:#f0f0f0;"|'''Source'''
| align="center" style="background:#f0f0f0;"|'''Tag Replacement'''
| align="center" style="background:#f0f0f0;"|'''badgecode'''
| align="center" style="background:#f0f0f0;"|'''Notes'''
|-
| <num>_application_state||useful for doing a strcmp in badgecode to automatically tag dealers on approved dealers/artists.||new||||||for correctness I want to call this group artshow, but these function will only really be used by dealers den
|-
| bool_<num>_confirmed||useful for a true false for flagging dealer badges.||new||||||these three are listed as options
|-
| bool_<num>_assistant||useful for a true false for flagging dealer assistant badges.||new||||||these three are listed as options
|}
{| class="wikitable"
|+ udf
| align="center" style="background:#f0f0f0;"|'''Substitution'''
| align="center" style="background:#f0f0f0;"|'''Description'''
| align="center" style="background:#f0f0f0;"|'''Source'''
| align="center" style="background:#f0f0f0;"|'''Tag Replacement'''
| align="center" style="background:#f0f0f0;"|'''badgecode'''
| align="center" style="background:#f0f0f0;"|'''Notes'''
|-
| <num>_title||Will display the title of the user defined field. (If the customer has it applied to them) Ex: $UDF_12_title.||Badgecode||||$udf_title||
|-
| <num>_value||Will display the value of the user defined field. (If the customer has it applied to them) Ex: $UDF_12_value.||Badgecode||||$udf_value||
|-
| bool_<num>||Returns True is the UDF has been answered||new||||||
|-
| <num>_type||returns the udf type||new||||||
|-
| <num>_udf_response_list||Will display the UDF questions if relevent||new||||||
|}
{| class="wikitable"
|+ product
| align="center" style="background:#f0f0f0;"|'''Substitution'''
| align="center" style="background:#f0f0f0;"|'''Description'''
| align="center" style="background:#f0f0f0;"|'''Source'''
| align="center" style="background:#f0f0f0;"|'''Tag Replacement'''
| align="center" style="background:#f0f0f0;"|'''badgecode'''
| align="center" style="background:#f0f0f0;"|'''Notes'''
|-
| bool_purchased_<num>||returns true if the customer has purchased the product||new||||||
|-
| bool_incart_||returns true if the customer has the product in their cart||new||||||
|-
| <num>_info||displays product description||new||||||
|-
| <num>_price||displays product price||new||||||
|-
| <num>_items_sold||displays how many have been sold||new||||||
|-
| <num>_items_remaining||displays how many are remaining (cart+purchased-inventory)||new||||||
|}
{| class="wikitable"
|+ system
| align="center" style="background:#f0f0f0;"|'''Substitution'''
| align="center" style="background:#f0f0f0;"|'''Description'''
| align="center" style="background:#f0f0f0;"|'''Source'''
| align="center" style="background:#f0f0f0;"|'''Tag Replacement'''
| align="center" style="background:#f0f0f0;"|'''badgecode'''
| align="center" style="background:#f0f0f0;"|'''Notes'''
|-
| cm_version||displays CM version string||new||||||
|-
| db_version||displays db db version int||new||||||
|-
| copyright||displays cm copyright statement||new||||||
|-
| license_expiration||displays license expiration date||new||||||
|-
| license_valid_events||displays list of valid events||new||||||
|-
| bool_dev_license||returns true if dev license||new||||||
|}
|}

Latest revision as of 21:45, 21 July 2021

General Idea

CM has a bunch of variable lookup systems, it would be helpful to combine these into one system.

This article is still a stub.

registrant
Substitution Description Source Tag Replacement badgecode Notes
uid outputs the registrant uid. Tag Replacements reg_uid $uid
legal_first outputs registrant first name. Tag Replacements reg_rl_first $registrant_rl_first
legal_last outputs registrant last name. Tag Replacements reg_rl_last $registrant_rl_last
legal_name outputs registrant "first" + "last" name. Tag Replacements reg_full_name
common_name outputs registrant badge name if not empty - otherwise thier "first" + "last" name. Tag Replacements reg_badge_name $registrant_fan_name
badge_name outputs registrant badge name. Tag Replacements reg_birthday $registrant_birthday
birthday outputs registrant birthdate. Tag Replacements reg_first_created
first_created outputs registrant account creation date from database. Tag Replacements reg_common_name $registrant_common_name
address_ship_to_name outputs registrant ship to name. Tag Replacements reg_address_ship_to_name
address_line_1 outputs registrant address line 1. Tag Replacements reg_address_line_1
address_line_2 outputs registrant address line 2. Tag Replacements reg_address_line_2
address_city outputs registrant address city. Tag Replacements reg_address_city
address_state outputs registrant address state. Tag Replacements reg_address_state
address_country outputs registrant address country. Tag Replacements reg_address_country
address_postcode outputs registrant address zip/postcode. Tag Replacements reg_address_zip
address_full outputs registrant address with all fields combined. Tag Replacements reg_address_full
phone_type outputs registrant phone type. Tag Replacements reg_phone_type
phone_number outputs registrant phone number. Tag Replacements reg_phone_number
email outputs registrant email. Tag Replacements reg_email
payment_hold_created outputs date payment hold was created for current registrant and event. Tag Replacements reg_payment_hold_created
payment_hold_expiry outputs date payment hold will expire for current registrant and event. ex: 2020-01-22 18:30:15 Tag Replacements reg_payment_hold_expiry
payment_hold_extendable_to outputs latest date payment hold can be extended up to for current registrant and event. Tag Replacements reg_payment_hold_extendable_to
payment_hold_payment_type outputs most recent payment type selected for current registrant and event Tag Replacements reg_payment_hold_payment_type
payment_hold_expiry_long outputs long date payment hold will expire for current registrant and event. ex: Wednesday, January 22, 2020, @ 6:30 PM Tag Replacements reg_payment_hold_expiry_long
bool_marked_deceased Returns True if the user is marked deceased new
bool_ConsoleUser Returns True if the user has an active console login new
consoleUserExpiryDate Displays expiration date for console login new
CompMoneyRemaining Displays the remaining comp money new


events
Substitution Description Source Tag Replacement badgecode Notes
event_id outputs the Event Id. Example: "DEMO_1" Tag Replacements event_id $event_id
event_title outputs the Event Title. Example: "Demo Event" Tag Replacements event_title $events_event_title
event_start_date outputs event start date from event settings. Tag Replacements event_start_date
event_end_date outputs event end date from event settings. Tag Replacements event_end_date
event_age_of_maturity outputs event age of maturity from event settings. Tag Replacements event_age_of_maturity
event_pre_reg_end_date outputs event pre-reg end date from event settings. Tag Replacements event_pre_reg_end_date
event_address_1 outputs address line 1 from event settings. Tag Replacements event_address_1
event_address_2 outputs address line 2 from event settings. Tag Replacements event_address_2
event_address_3 outputs address line 3 from event settings. Tag Replacements event_address_3
event_address_4 outputs address line 4 from event settings. Tag Replacements event_address_4
event_address_full outputs event address with all fields combined. new
event_defaultFromEmail outputs default from email address in event settings. Tag Replacements event_defaultFromEmail
event_defaultReplyTo outputs default reply to: in event settings. Tag Replacements event_defaultReplyTo
event_chequeToName outputs cheque to name in event settings. Tag Replacements event_chequeToName
attendee
Substitution Description Source Tag Replacement badgecode Notes
bool_underage true if below age of maturity set for event from birthdate and stored event age of maturity badgecode $underage
num registration sequence number for that particular event Tag Replacements reg_reg_num $events_attended_reg_num
badge_display_code outputs registrant badge layout code. Example: FNOT Tag Replacements reg_badge_display_code
membership_name outputs membership name. (setting: Group Name) Tag Replacements reg_membership_name $event_membership_types_name
membership_long_name outputs membership long name. (setting: Membership Type as printed on badge) Tag Replacements reg_membership_long_name $event_membership_types_long_name
membership_full_desc outputs membership description. (setting: Sales pitch description:) Tag Replacements reg_membership_full_desc
membership_rules outputs membership rules. (setting: Rules For this membership) Tag Replacements reg_membership_rules
membership_type outputs registrant membership code for current event. Example SPON_0 Tag Replacements reg_membership_type
membership_last_updated outputs membership last modified date for current event. Tag Replacements reg_membership_last_updated
membership_price outputs membership price. Tag Replacements reg_membership_price
membership_avail_from outputs membership available from date. Tag Replacements reg_membership_avail_from
membership_avail_to outputs membership available to date. Tag Replacements reg_membership_avail_to
staff if attendee_membership_name contains the word 'staff' this will equal true, this is not case sensitive. badgecode $staff if retained, maybe this should also check membership_long_name
panelist
Substitution Description Source Tag Replacement badgecode Notes
bool_has_confirmed_activity useful for a true false for flagging panelist badges. new This is highly speculative, however I'm presuming this would work something like AS/DD in that the application would be tied to the UID of the person who applied, so we could pick it up that way, it could go into the attendee group
bool_activity_host useful for a true false for flagging panelist badges. new
bool_activity_assistant useful for a true false for flagging panelist badges. new
bool_is_panelist true if uid matches to either activity host or assistant - useful for a true false for flagging panelist badges. new
activity_schedule displays a formatted list of activities a panelist is assigned/confirmed to new
dealers
Substitution Description Source Tag Replacement badgecode Notes
<num>_application_state useful for doing a strcmp in badgecode to automatically tag dealers on approved dealers/artists. new for correctness I want to call this group artshow, but these function will only really be used by dealers den
bool_<num>_confirmed useful for a true false for flagging dealer badges. new these three are listed as options
bool_<num>_assistant useful for a true false for flagging dealer assistant badges. new these three are listed as options
udf
Substitution Description Source Tag Replacement badgecode Notes
<num>_title Will display the title of the user defined field. (If the customer has it applied to them) Ex: $UDF_12_title. Badgecode $udf_title
<num>_value Will display the value of the user defined field. (If the customer has it applied to them) Ex: $UDF_12_value. Badgecode $udf_value
bool_<num> Returns True is the UDF has been answered new
<num>_type returns the udf type new
<num>_udf_response_list Will display the UDF questions if relevent new
product
Substitution Description Source Tag Replacement badgecode Notes
bool_purchased_<num> returns true if the customer has purchased the product new
bool_incart_ returns true if the customer has the product in their cart new
<num>_info displays product description new
<num>_price displays product price new
<num>_items_sold displays how many have been sold new
<num>_items_remaining displays how many are remaining (cart+purchased-inventory) new
system
Substitution Description Source Tag Replacement badgecode Notes
cm_version displays CM version string new
db_version displays db db version int new
copyright displays cm copyright statement new
license_expiration displays license expiration date new
license_valid_events displays list of valid events new
bool_dev_license returns true if dev license new