Kavi® Showcase Help
Table of Contents
Template variables represent fields in the Kavi Showcase database. When a template-based email is sent, each variable in the template is replaced with a real value retrieved from the database. For example, the variable '$org_name' is replaced with the name of your organization.
Template variables are prefixed with a "$" (to indicate that this is a variable and not a plain text value) followed by a short text string identifying the object (e.g., "org"), then an underscore ("_"). The rest of the variable consists of a short but meaningful text string that identifies the data field, such as ('name'). The variable name is frequently based on the name of the database column, so you can often match the variable up with data fields in reports. Some examples are '$org_name' (the name of your organization), '$showcase_name' (the name of your showcase), '$p_name' ('$p_' identifies a profile variable, so this is a profile name), '$c_name' ('$c_' identifies a catalog item variable, so this is a catalog item name).
The variables documented here are available by default in Kavi Showcase page text and email templates. Your website may use custom variables that represent custom fields in your organization's database. These variables aren't documented here, but should be recognizable because they conform to the standard formats we just described: a prefix followed by a short-but-meaningful text string. Each custom variable corresponds to a custom field that can be retrieved through reports, so you can consult Kavi Showcase reports for more information on these fields.
Default template variables for catalog item data fields are shown in this table. The variables shown here may differ from those available on your website depending on Kavi Showcase configuration and whether custom fields have been added for catalog items.
Table G.1. Catalog Item Template Variables
| Variable | Example | Description |
|---|---|---|
| $c_category | Peripheral Devices | Any categories assigned to this catalog item. |
| $c_contacts | admin@kavi.com | The full names and email addresses of this catalog item's contacts. |
| $c_date_added | Mar 21, 2006 15:12:55 | The date this catalog item was added to Kavi Showcase. |
| $c_description | Standards-compliant AC/DC plug-n-play peripheral. | The description of the catalog item as it appears in the catalog. |
| $p_display_publicly | Yes | Shows whether the profile is set to display publicly or not. |
| $c_featured | Yes | Indicates whether this catalog item has been selected for featuring. |
| $c_featured_end | Nov 7, 2006 | If this catalog item was selected for featuring, this shows the date that featuring ends. If this is 'none', the item is currently being featured and no end date is specified. If this is blank, the item hasn't been featured yet. |
| $c_featured_start | Oct 7, 2006 | If this catalog item has been selected for featuring, this shows the date that featuring begins. If this is 'none', no start date has been specified. If this is blank, the item hasn't been selected for featuring. |
| $c_last_modified | 11 Apr 2006 14:22:55 GMT-7 | The last_modified for this catalog item, showing the date and time of the most recent change. |
| $c_moderate_link | http://www.example.org/showcase/members/approve_catalog?participant_key=12345678 | A link to the Member Area Moderate Catalog Items tool where the moderator can moderate this catalog item. |
| $c_name | Standards-Compliant Peripheral | This catalog item's name. |
| $c_public_date | 21 Nov 2006 15:12:55 | A timestamp added the first time this catalog item was displayed in the catalog. |
| $c_search_keywords | standards-compliant, peripheral | A list of keywords used to enhance retrieval of this catalog item in searches. |
| $c_state | Active | This catalog item's State. |
| $c_status | Active | This catalog item's Status. |
| $c_url | http://www.examplecorp.com/products/peripheral#standards-compliant | The URL for this catalog item. |
Default template variables for organization data fields are listed in this table.
Table G.2. Organization Template Variables
| Variable | Example | Description |
|---|---|---|
| $org_admin_email | admin@example.org | The administrative alias for your organization. This variable is available for all email templates. |
| $org_name | Your Organization Name | The name of your organization. This variable is available for all email templates. |
Default template variables for profile data fields are shown in this table. The variables shown here may differ from those available on your website depending on Kavi Showcase configuration and whether custom fields have been added for profiles.
Table G.3. Profile Template Variables
| Variable | Example | Description |
|---|---|---|
| $p_address | 123 SW Main Street Portland, OR 97215 USA | The full address for this profile. |
| $p_category | Peripheral Devices | Any categories assigned to this profile. |
| $p_city | Portland | The city portion of the address for this profile. |
| $p_contacts | George Washington (george.washington@us.presidents.gov), Thomas Jefferson (thomas.jefferson@us.presidents.gov) | The full names and email addresses of this profile's contacts. These contacts are defined and assigned in Kavi Showcase, and displayed as contacts when the profile is displayed. |
| $p_country | USA | The country portion of the address for this profile. |
| $p_description | A standards-compliant, plug-and-play peripheral device. | The description of the profile as it appears in the catalog. |
| $p_display_publicly | Yes | Shows whether the profile is set to display publicly or not. |
| $p_email | main_email@example.com | The main contact email address for this profile. |
| $p_featured | yes | Indicates whether this profile has been selected for featuring. |
| $p_featured_end | Nov 7, 2006 | If this profile has been selected for featuring, this shows the date that featuring is scheduled to end. If this is 'None', no end date is specified, and the profile will be featured indefinitely. |
| $p_featured_start | Oct 7, 2006 | If this profile has been selected for featuring, this shows the date that featuring is scheduled to begin. If this is 'None', no start date has been specified. |
| $p_last_modified | 11 Apr 2006 14:22:55 GMT-7 | This profile's last_modified date. |
| $p_moderate_link | http://www.example.org/showcase/members/moderate_profiles?participant_key=12345678 | A link to the Moderate Profiles tool. |
| $p_name | Standards-Compliant Peripheral | This profile's name. |
| $p_postal_code | 97215 | The postal code (a.k.a zip code) portion of the address for this profile. |
| $p_public_date | 21 Nov 2006 15:12:55 | A timestamp set when 'Display Publicly' was first set to 'Yes' for this profile. |
| $p_search_keywords | standards-compliant, peripheral | A list of keywords used to enhance retrieval of this profile in searches. |
| $p_state | Active | This profile's State. |
| $p_state_province | OR | The state or province portion of the address for this profile. |
| $p_status | Active | This profile's Status. |
| $p_street | 123 SW Main Street | The street address portion of this profile's address. |
| $p_url | http://www.examplecorp.com/products/peripheral#standards-compliant | This profile's URL. |
Default template variables for showcase data fields are listed in this table. The variables shown here may differ from those available on your website depending on Kavi Showcase configuration and whether custom fields have been added.
Table G.4. Showcase Template Variables
| Variable | Example | Description |
|---|---|---|
| $showcase_name | Product and Service Showcase | The name of your organization's showcase, as set in the Configure Kavi Showcase tool. This variable is available for all email templates. |