Kavi® Members Help

Appendix G. Kavi Members Template Variables
Prev  Part X. Appendix  Next

Appendix G. Kavi Members Template Variables

Table of Contents

Overview
Company Template Variables
Organization Template Variables
Membership Template Variables
User Template Variables

Overview

Template variables represent fields in the Kavi Members 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 variable naming conventions

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 that indicates what the variable is about. The prefix terminates in underscore ('_'), to distinguish it from the rest of the variable.

An organization, its member companies and users tend to share common attributes (e.g. 'status', 'phone', 'fax', etc.), which means that a column of the same name may appear in more than one table in the database. The prefix tells the software which table it needs to pull the data from when it populates the variable. To expand on the previous example, the variables '$org_name', '$c_name' correspond to organization name and company name, respectively.

Custom variables

The variables documented here are available by default in Kavi Members text and email templates. Email templates for your web site may include custom variables that represent custom fields in your organization's database. These variables aren't documented here, but should use the standard prefixes and correspond to custom fields displayed in report results.

Back to top

Company Template Variables

Default template variables for company data fields are shown in this table. The variables shown here may differ from those available on your site web site depending on Kavi Members configuration and whether custom fields have been added for companies.

Table G.1. Company Template Variables

Variable Example Description
$c_accepted_domains kavi.com The list of accepted domains for this company.
$c_address 123 SW Main Street Portland, OR 97215 USA The full address of this company.
$c_admin_contacts admin@kavi.com The email addresses (or email alias) of this company's Admins.
$c_admin_manage_link http://www.example.org/kmembers/admin/manage_company A link to the Manage a Company tool that Organization Admins can use to manage this company.
$c_billing_contacts billing@kavi.com The email addresses (or email alias) of this company's Billing Contact. This variable is available if Kavi® Billing is installed.
$c_company_type Staff Company A list of Company Types assigned to this company.
$c_deactivation_date Oct 7, 2004 This company's deactivation date, if this company is inactive.
$c_display_publicly Yes This company's setting for the Display Publicly option.
$c_edit_link http://www.example.org/kmembers/company/company_edit A link to the Edit a Company tool in the Company Area. Company Admins and Primary Contacts can use this link to edit their company's information.
$c_last_modified 11 Apr 2006 14:22:55 GMT-7 This company's last_modified date.
$c_membership_expiration_date March 16, 2006 The expiration date for this company's membership.
$c_membership_info http://www.example.org/kmembership_info A link to the Membership Info page where the company's Primary Contact and Company Admin can view company membership information.
$c_membership_status_link http://www.example.org/kmembership_info/membership_status?participant_key=12345678 A link to the Membership Status page where the company's Primary Contact and Company Admin can view this company's membership status.
$c_moderate_company_member_link http://www.example.org/admin/moderate_company_membership?participant_key=12345678 A link to the Manage a Company Membership Application tool, which an Organization Admin can use to moderate this company's membership application.
$c_modification_time Jun 16, 2006 4:03 pm US/Pacific A timestamp displaying the date and time the email is generated.
$c_name Example Corporation This company's name.
$c_primary_contacts primary.contact@kavi.com The email addresses (or email alias) of this company's Primary Contacts.
$c_purpose Member This company's Purpose.
$c_show_on_signup_form Yes The setting for Show on Signup.
$c_showcase_company_editor_contacts showcase_company_ed@kavi.com The email addresses (or email alias) of this company's Showcase Company Editor. This variable is available if Kavi® Showcase is installed.
$c_signup_date 21 Nov 2003 This company's Signup Date.
$c_status Active This company's Status.
$c_url http://www.examplecorp.com This company's URL.
Back to top

Organization Template Variables

Default template variables for organization data fields are shown in this table.

Table G.2. Organization Template Variables

Variable Example Description
$org_admin_email admin@example.org The name of the organization
$org_name Example Organization The name of the organization
Back to top

Membership Template Variables

Default template variables for membership data fields are shown in this table. The variables shown here may differ from those available on your site web site depending on Kavi Members configuration and whether custom fields have been added for memberships.

Table G.3. Membership Template Variables

Variable Example Description
activation_date 2006/06/16 This membership's activation date.
$m_amount_billed $1000 The Amount Billed for this membership.
$m_archived_date_predicted 2007/06/16 The date this membership at which this membership is scheduled to be archived.
$m_archived_date 2005/06/16 This membership's actual archived date, if the membership expired and was archived.
$m_bill_state Paid The state of the bill issued for this membership.
$m_comment Free text comment. A comment associated with the Renewal Intention for this membership.
$m_creation_date 2006/06/16 This membership's creation date.
$m_expiration_date 2007/06/16 This membership's end date.
$m_last_modified 2006/06/16 This membership's last modified date.
$m_membership_type Board Member This membership's type.
$m_moderate_link http://www.example.org/kmembers/admin/moderate_indiv_membership?123456789 A link that administrators can use to moderate the application for this membership.
$m_moderated_date 2006/06/16 This membership's moderated date.
$m_moderation_queue_date 2006/06/16 This membership's moderation queue date.
$m_renewal_info intending to renew The renewal intention for this membership.
$m_renewed_with Sponsor If this membership has been renewed, this is the membership type selected during the renewal process.
$m_replaced_with Board If this membership has been replaced, this is the membership type selected as the replacement.
$m_source Valid values are 'New' or 'Renewal'. The 'Source' field shows whether this is a first-time membership (i.e., 'New') or a renewed membership (i.e., 'Renewal'). This membership's source.
$m_start_date 2006/06/16 This membership's start date.
$m_status Active This membership's status.
$m_status_link http://www.example.org/kmembership_info/membership_status?form_key=123456789 A link to the Membership Status page.
Back to top

User Template Variables

A list of the variables that are available to be included in the template text. Variables are used to represent information stored in the database. The variables available by default for email sent to a user are shown in the table below. The variables shown here may differ from those available on your site depending on how Kavi Members is configured and whether custom fields have been added for users.

Table G.4. Template Variables for Users

Variable Example
$u_address 123 SW Main Street Portland, OR 97215 USA The full address of this user.
$u_admin_manage_link http://www.example.org/kmembers/admin/manage_person?123456789 A link to the Manage a User tool that Organization Admins can use to manage this user.
$u_cell_phone 503-555-1212 The user's cell phone number.
$u_change_password_link http://www.example.com/kbl?k=123456 or http://www.example.com/kmembers/person/change_password The shorter link is sent when the user has requested a new password. The longer link is sent when a user already has a password. It takes the user to the change password page where they can change their username and password.
$u_company_name Example Corporation The name of the company to which this user belongs.
$u_contact_types Primary Contact A list of Company Admin and Contact Types assigned to this user.
$u_deactivation_date Oct 7, 2004 This user's deactivation_date, if this user is inactive.
$u_display_publicly Yes This user's setting for the Display Publicly option.
$u_edit_link http://www.example.org/kmembers/person/change_personal_info/ A link to the Edit Your Account tool in the Members Area. The user can use this link to edit their account information.
$u_fax_phone 503-555-1213 This user's fax number.
$u_first_name Jean This user's first name.
$u_fullname Jean Lee Nguyen This user's full name.
$u_home_phone 503-555-1214 This user's home phone number.
$u_last_modified 23 Aug 2006 16:24:35 GMT-7 This user's last_modified date.
$u_last_name Nguyen This user's last name.
$u_membership_expiration_date Dec 3, 2006 The expiration date for this user's membership.
$u_membership_status_link http://www.example.org/kmembership_info/membership_status?participant_key=12345678 This user's ???.
$u_middle_name Lee This user's middle name.
$u_moderate_company_rep_link http://www.example.org/admin/moderate_company_membership?participant_key=12345678 A link to the Manage a Company Representative Application tool, which an Organization Admin can use to moderate this company representative's application.
$u_moderate_indiv_member_link http://www.example.org/admin/moderate_individual_membership?participant_key=12345678 A link to the Manage an Individual Membership Application tool, which an Organization Admin can use to moderate this company's membership application.
$u_modification_time Jun 16, 2006 4:03 pm US/Pacific A timestamp displaying the date and time the email is generated.
$u_primary_email user.name@example.com This user's primary email address.
$u_purpose Company Representative This user's Purpose.
$u_receive_email Yes This user's setting for the Receive Email option.
$u_salutation Ms. This user's preferred salutation.
$u_secondary_email username@example.net This user's secondary email address.
$u_signup_date 21 Nov 2003 This user's signup date.
$u_status Active This user's status.
$u_title Director of Communications This user's job title.
$u_username jean.nguyen This user's username.
$u_work_phone 503-555-1215 This user's work phone.
Back to top
Prev  Up  Next
Appendix F. Sample User Data Files for the Upload Data Tool  Home  Appendix H. Upload Data Instructions for Add, Edit and Delete Actions