Kavi® Showcase Help
Table of Contents
Kavi Showcase configuration has a dramatic effect on the behavior and appearance of many Kavi Showcase tools. When Kavi Showcase is initially installed, the defaults are automatically pre-set to values most commonly used by technical standards organizations. These settings need to reviewed and customized as necessary to fit your organization's requirements. Each configuration option available through this tool is decribed in detail.
Some options allow the organization to grant permissions to non-administrators that might otherwise be reserved for administrators. For more information on special types of users, see Kavi Showcase Default Types and Kavi Showcase Permissions.
Important
In order for your changes to take effect, the application must be updated.
Reconfiguring an option is a two-part process:
-
On the Showcase Options form, click the radio button next to the option you wish to edit, then click Edit Selected Option. Forms are displayed to guide you through the editing process. Click the Save button to save your edit. Your edit is saved, but it doesn't go into effect until you update the application. You will be returned to the Showcase Options form.
If you want to edit other options, you may repeat this step any number of times.
When you are ready to update the application so your new configuration settings go into effect, click Update Application.
View your site's configuration settings.
Edit configuration settings and update the application.
Options:
- catitem_files: Can files be uploaded with catalog items?
-
YES: This setting allows a file to be uploaded for each catalog item. When the catalog item is displayed in Kavi Showcase, a link to the file appears next to the 'More Info' label. These uploaded files tend to increase the amount of server storage space used by the site but most organizations use this option to distribute product literature or white papers in PDF or other standard format. 'YES' is the default setting.
NO: Users cannot upload a file with catalog items.
- catitem_image_height: Catalog item image maximum height in pixels
-
This option sets the maximum allowed height for a catalog item image. The height of the image is one factor that may determine the file size and storage requirements for the image. Image height and width also affect the layout of the page where the item is displayed. Large images can distort the surrounding page structure, and should be discouraged. The default is 300, but many organizations prefer smaller images.
See the image below for a better understanding of different pixel sizes.
- catitem_image_width: Catalog item image maximum width in pixels
-
This option sets the maximum allowed width for a catalog item image. Image height and width affect catalog page layout and database storage requirements. Images whose width is approximately equal to the default of 300 pixels tend to support more detailed imagery than images whose width is 200 pixels, but a smaller image size allows a greater number of images to fit into a given space. Images whose width is greater than 300 pixels can distort the structure of surrounding page elements so limits higher than 300 pixels should generally be avoided. Image size also affects file sizes and storage requirements, so a site that supports larger images requires more storage space per image than sites that enforce smaller size limits.
See the image above for a better understanding of different pixel sizes.
- contacts_edit: Can catalog item contacts edit their catalog items?
-
YES: Use this setting to allow a user who is designated as a catalog item contact to edit their catalog item's description, image, files and other details. If the organization has catalog item moderation enabled, a Showcase Moderator has to approve the edits before the catalog item can be displayed. This setting is recommended for most organizations.
NO: Use this setting if the organization wants Showcase Admins and other organization administrators to retain complete control over the editing of catalog item information.
- editors_add: Can profile owners and users designated as catalog item contacts add catalog items?
-
YES: Use this setting if the organization wants to allow profile owners and catalog item contacts to add new catalog items for their profile. If the organization has catalog item moderation enabled, a Showcase Moderator has to approve the new catalog item before it can be displayed.
NO: Use this setting if the organization wants Showcase Admins and other organization administrators to retain complete control over the addition of new catalog items. Profile owners and catalog item contacts won't be allowed to add new catalog items, but they may be allowed to edit them if the 'contacts_edit' option is set to 'YES'.
- editors_delete: Can profile owners and users designated as catalog item contacts delete catalog items?
-
YES: Use this setting if the organization wants to allow profile owners and catalog item contacts to delete catalog items from their profile. Even if moderation is enabled, this setting allows these users to permanently delete catalog items without moderator approval.
NO: Use this setting if the organization wants Showcase Admins and other organization administrators to retain complete control over catalog item deletion.
- flat_categories: Are catalog item categories restricted to a single level?
-
YES: Disallows nested subcategories for organizations that only want to manage one level of catalog item categories.
NO: Allows the organization to define a nested item category structure. Most organizations use nested catalog item categories.
- hide_items: Can catalog items be hidden from the showcase?
-
YES: This setting enables the Display Publicly field, which represents the profile owner's or catalog item contact's display preferences. If enabled, the 'Display Publicly' option is available to administrators when adding and editing catalog items. If the 'editors_edit' or 'editors_add' options are set to 'YES', this option is also available to profile owners and catalog item contacts. It can be used when the profile owner or catalog item contact wants to hide a catalog item that is active and approved. This can be used to keep a new catalog item hidden until ready to launch or to hide an older item that is being replaced with a newer version.
NO: Use this setting if the organization doesn't want to use the 'Display Publicly' option.
- hide_no_cat_profile: Should profiles with no catalog items be hidden from the public searches?
-
YES: Any profile that doesn't have an associated catalog item is omitted from public pages and doesn't appear when users browse or search profiles on public pages.
NO: All profiles in the database are displayed on the public pages, regardless of whether there are any associated catalog items.
- manage_catitem: Can catalog items be managed in the Showcase Member Tools area?
-
YES: Links to Catalog Items are displayed in the Kavi Showcase Member Area and authorized account holders can use Kavi Showcase Member Tools to manage Catalog Items including the Manage Catalog Items and Add a Catalog Item tools. The Edit a Catalog Item tool is available if 'contacts_edit' is enabled and the Delete a Catalog Item tool is available if 'editors_delete' is enabled.
NO: Links to Catalog Items are NOT displayed in the Kavi Showcase Member Area. When this option is enabled, the 'contacts_edit', 'editors_add' and 'editors_delete' options are ignored.
- manual_feature_catalog: Are catalog items manually selected to be featured?
-
YES: Use this setting if the organization wants manual selection of featured catalog items.
NO: Use this setting if the organization wants automated selection of featured catalog items.
- manual_feature_profile: Are profiles manually selected to be featured?
-
YES: Use this setting if the organization wants manual selection of featured profiles.
NO: Use this setting if the organization wants automated selection of featured profiles.
- member_request_catalog_category: Display a catalog item category request form?
-
YES: Use this setting if the organization wants to display a form that members can use to request new catalog item categories.
NO: Use this setting if the organization does NOT want to display a form that members can use to request new catalog item categories.
- member_request_profile_category: Display a profile category request form?
-
YES: Use this setting if the organization wants to display a form that members can use to request new profile categories.
NO: Use this setting if the organization does NOT want to display a form that members can use to request new profile categories.
- mod_catalog: Are catalog items moderated?
-
YES: This option allows the organization to retain oversight over catalog items when the 'editors_edit' or 'editors_add' options are set to 'YES'. When a catalog item is added or edited by a profile owner or catalog item contact, it enters the 'Pending' state and is sent to a moderator for review. If the moderator sets the state to 'Approved', the catalog item may be eligible for display. This option gives the organization additional oversight of catalog content, but requires an extra time commitment on the part of Showcase Moderators and administrators.
NO: New and edited catalog items are automatically set to the 'Approved' state.
- mod_profiles: Are profiles moderated?
-
YES: This option allows the organization to retain oversight over profiles when the 'editors_edit' or 'editors_add' options are set to 'YES'. When a profile is added or edited by a profile owner or profile contact, it enters the 'Pending' state and is sent to a moderator for review. If the moderator sets the state to 'Approved', the profile may be eligible for display. This option gives the organization additional oversight of profile content, but requires an extra time commitment on the part of Showcase Moderators and administrators.
NO: All new and edited profiles are automatically approved.
- multi_categories: Can catalog items be in more than one category at a time?
-
YES: Catalog items can be assigned to multiple categories at one time.
NO: Catalog items can only be in one category at a time. If the Compliance feature is enabled, this option must be set to 'NO'.
- profile_flat_categories: Are profile categories restricted to a single level?
-
YES: Disallows nested subcategories for organizations that only want to manage one level of profile categories.
NO: Allows the organization to define a nested, multi-level category structure for profiles.
- profile_image_height: Profile image maximum height in pixels
-
This option sets the maximum allowed width for a profile image. Image height and width affect profile page layout and database storage requirements. Images whose width is approximately equal to the default of 300 pixels tend to support more detailed imagery than images whose width is 200 pixels, but a smaller image size allows a greater number of images to fit into a given space. Images whose width is greater than 300 pixels can distort the structure of surrounding page elements so limits higher than 300 pixels should generally be avoided. Image size also affects file sizes and storage requirements, so a site that supports larger images requires more storage space per image than sites that enforce smaller size limits.
See the image below for a better understanding of different pixel sizes.
- profile_image_width: Profile image maximum width in pixels
-
Changes the maximum allowed width for a profile image. The width of the image is one factor that may determine the file size and storage requirements for the image. Image height and width also affect the layout of the page where the profile is displayed. Large images can distort the surrounding page structure, which should be avoided. The default is 300 pixels.
See the image above for a better understanding of different pixel sizes.
- profile_member_status: Should the status of a profile match the status assigned to the owner in Kavi® Members?
-
YES: When set to 'Yes', profiles are automatically activated or deactivated when the user or company to which the profile belongs is activated or deactivated. This option is recommended for most organizations because it automates an important aspect of showcase maintenance.
NO: Profile status is only changed manually by administrators, retaining its value regardless of the owner's status.
- profile_multi_categories: Can profiles be in more than one category at a time?
-
YES: Profiles can be assigned to multiple categories at one time.
NO: Profiles can only be assigned to one category at a time.
- profile_name_editable: Can members customize their profile name?
-
YES: Use this setting if the organization wants to allow profile owners and profile contacts to edit the profile name, potentially assigning a different name than the one for the linked account in the Kavi Members database.
NO: Profile names can only be edited by administrators.
- profile_url_editable: Can members customize their profile URL?
-
YES: Profile owners and profile contacts can edit their profile's URL to be different than the URL in their member account.
NO: Profile URLs can only be edited by administrators.
- showcase_name: Showcase Name for Email Templates
This is the value of the $showcase_name variable. By default, this variable is populated with the name of the organization followed by the string that is set as the 'Default Showcase Name'. To change this value, select this option and click Edit Selected Value. Type in your preferred value (e.g., 'Showcase')in the text box and click Save. This value is inserted in place of the '$showcase_name' variable in page text templates and email templates that use this variable.
Compliance options are displayed if Compliance is enabled on your organization's website.
- compliance_landing_state: What state should items enter after passing compliance testing?
-
The default value is 'Approved', but this is editable.
To edit this value, select this option and click Edit Selected Option. A form is displayed where you can enter the new value in the text field and click Save to save your edits. As with other configuration options, you must click Update Application for these changes to take effect.
