Kavi Help CenterKavi® Showcase Help
| Appendix C. Catalog Item Data Fields | ||
|---|---|---|
 |
Part VII. Kavi Showcase Appendix | 
|
Table of Contents
Kavi Showcase provides an extensive set of predefined data fields and these can be extended by the addition of custom fields. This document provides information about the most important default catalog item fields. Depending on configuration, you may not see all the fields listed here and you may also see fields that are not listed here. Some organizations only have the profile feature enabled, in which case no catalog item fields will be installed.
Note
Kavi Showcase automatically adds an email template variable for every field and makes the field available through report tools.
Table C.1. Catalog Item Data Fields Table
|
Field Name database_column |
Required? | Description |
|---|---|---|
|
Category catalog_categories |
Required | Every catalog item is assigned one or more categories. Categories determine how a catalog item is displayed in the showcase and are used to retrieve the catalog item in searches. |
|
Contact catalog_contact |
Full name and email address of the person designated as Catalog Item contact. | |
|
Created Date catalog_created_date |
Date and time this catalog item was added to the database. | |
|
Description catalog_description |
Catalog item description in plain text or HTML. This is the description displayed in the showcase. | |
|
Display Publicly catalog_display_publicly |
Required | This value can be set by the Profile Owner or Showcase Company Admin to keep a catalog item that is otherwise eligible for display from appearing in the showcase. The value may be 'Display Publicly' (1) or 'Yes'; or 'Do Not Display' (0) or 'No'. If set to 'No' or 'Do Not Display', the catalog item is not displayed in the showcase. If set to 'Yes', the catalog item is displayed in the showcase if it meets all other eligibility criteria (e.g., belongs to an active profile and was approved by a Showcase Moderator). |
|
Featured End Date catalog_featured_end |
Optional | If this catalog item was featured and the featuring has ended, the end date is recorded in this field. There are two scenarios under which this field is blank: either the catalog item was not featured (in which case the Featured Start Date will also be blank) or else is currently featured (as you can see by looking at the Featured Start Date). |
|
Featured Start Date catalog_featured_start |
Optional | If this catalog item was featured, the start date is recorded in this field. If it is blank, the catalog item was not featured. |
|
File catalog_file_url |
URL for a downloadable file for this catalog item, such as a PDF version of a product sheet. | |
|
Image catalog_image_url |
Link to the image file for this catalog item. | |
|
Item Key catalog_item_key |
Required | Non-editable unique ID. |
|
Keywords catalog_keywords |
Searchable terms assigned to a catalog item. These terms are not displayed to the public, but transparently enhance retrieval of the item when one of these keywords is used in a search. | |
|
Last Modified catalog_last_modified |
A timestamp showing the most recent date and time that this catalog item's data was edited. | |
|
catalog_master_key |
Required | Reference to the unique ID for a set of related catalog items. |
|
Name catalog_name |
catalog item name. Required | |
|
Profile admin_profile |
Required | Name of the Profile with which this catalog item is associated. |
|
Public Date public_date |
The date that this catalog item became eligible for display in the showcase. When a catalog item is first added to a showcase, it is usually visible only to administrators, the catalog item contact or Showcase Company Admin, etc. Once it is approved and set to display publicly it becomes visible to regular users as they browse or search the showcase. When this happens, a date stamp is added to the this field. | |
|
State catalog_state |
Required | This can be 'Working', 'Pending', 'Approved' or 'Rejected'. For more information, see Workflow. |
|
Status catalog_status |
Required | This can be 'Active' (1) or 'Inactive' (0). 'Inactive' catalog items aren't displayed. |
|
URL catalog_url |
Optional | URL that is displayed to users as a link they can click to get more information about this catalog item (must include the http:// prefix). |
|
|
 |
|
| Appendix B. Kavi Showcase Default Roles |  |
Appendix D. Profile Data Fields |