Service Catalog properties
- UpdatedAug 1, 2024
- 15 minutes to read
- Xanadu
- Now Platform Capabilities
The Service Catalog application contains properties used to configure various settings in the application.
To configure Service Catalog system properties, navigate to . The properties are categorized into the following sections.
- Homepage: Configure settings for the Service Catalog homepage, and control the behavior of the categories and the items displayed on the homepage.
- Catalog Items: Configure settings for catalog items and record producers.
- : Configure settings for the order guide.
- : Configure settings for scriptable order guides.
- Cart: Control the behavior of the shopping cart and checkout screens.
- Request Fulfillment: Configure settings for request fulfillment processes.
- Search: Configure search settings for the Service Catalog homepage.
- Security: Configure security settings for the Service Catalog.
- Pricing: Configure settings for the pricing engine and pricing display.
- Portal: Configure settings for catalog portal widgets.
- Virtual Agent: Configure settings for request submission in
Virtual Agent.
This section is visible only when you activate the Service Management Virtual Agent Topic Blocks plugin (com.glideapp.cs.sm_topic_blocks) .
- Mobile: Configure settings for Now Mobile.
- Other: Additional settings for the Service Catalog.
| Name | Description |
|---|---|
| Homepage | |
| Number of Catalog Items/Categories to preview in a section (glide.sc.max_items) | Number of catalog items or categories to preview in a section:
|
| Show category descriptions in the category view page ( com.glide.servicecatalog.view_includes_category_descriptions) | Show category descriptions in the category view page:
|
| In category view display subcategories in a panel ( glide.sc.use_sub_cat_section) | In category view, display subcategories in a panel:
|
| Toggle whether the expand/collapse icon is rendered for category widgets on the service catalog homepage ( glide.sc.homepage.show.collapse) | Toggle whether the expand/collapse icon is rendered for category widgets on the
service catalog homepage:
|
| When browsing a category use the pop-up icon to show item details ( glide.sc.cat_view_use_popup_for_details) | When browsing for a category or a catalog item, use the info icon next to the
category or catalog item to preview category or item details:
|
| Number of catalog items to expand in browsing and search when not using pop-up icons to view details ( glide.sc.auto_expand) | Number of catalog items to expand in browsing and search when not using pop-up
icons to view details:
|
| Show the additional categories section when viewing a catalog item ( glide.sc.show_additional_cats) | Show the additional categories section when viewing a catalog item:
|
| Limit descriptions in category and item listings to two rows in the Mobile UI ( glide.sc.mobile.limit.description) | Limit descriptions in the category and item listings to two rows in the Classic
Mobile UI:
|
| List of content types (comma-separated) to allow on the catalog homepage. Blank allows all content types. (glide.sc.home.filter) | List of content types (comma-separated) to allow on the catalog homepage. Blank indicates all content types. |
| Name of placeholder picture for items that don't have a picture defined ( glide.sc.placeholder.image) | Name of the placeholder picture for items that don't have a picture defined.
Applicable only to Classic Mobile and not Desktop. By default, two images are available: sc_placeholder_image.png and sc_placeholder_image-01.png. In addition, the default can be replaced with a custom image: Default value: sc_placeholder_image.png |
| Catalog Items | |
| Specifies the default behavior of record producer after record generation (glide.sc.producer.redirect_url) | Default redirect behavior of the record producer after its
generation. Possible values:
Override this behavior by editing the value of the Redirect To field of the record producer or defining the redirect code in the Script field of the record producer. |
| Enabling this makes sure that the attachments uploaded to the attachment variable are deleted from the system if and when they are replaced/deleted on the form (glide.sc.variable.attachment.delete.v2) | Automatically deletes a sys_attachment record from the system when you replace or delete an attachment from a catalog item attachment variable. |
| List of class names for catalog items that can't be added to an existing request ( glide.sc.item.cannot_add_to_request) | List of class names for catalog items that can’t be added to an existing
request:
|
| List of class names for catalog items that don’t use the default "Try It" UI action ( glide.sc.item.cannot_try_it) | List of class names for catalog items that don't use the default "Try It" UI
action:
|
| List of class names for catalog items that don’t generate a normal cart item ( glide.sc.item.not_normal_cart_item) | List of class names for catalog items that don't generate a normal cart
item:
|
| Relationship tables which should be part of 'Copy Item' action. Table Name should be comma-separated ( glide.sc.item.copy.include_relationship) | Specify the tables in which the records having a reference to a catalog item
are also copied when you copy the catalog item using the Copy
UI action: Note: Table names should be comma-separated without any
spaces. |
| Disables clickthrough via the info-icon on a reference variable. Set value to true to enable this functionality (glide.sc.variable.reference.clickthrough) | Disable clickthrough via the info icon on a reference variable. Set the value to true to enable this functionality. |
| Order Guides | |
| General | |
| List of class names for catalog items that can’t be included in an order guide (glide.sc.item.order_guide_exclusion) | Comma-separated list of class names for catalog items that can’t be included in an order guide. For example, sc_cat_item_guide and sc_cat_item_content. |
| Validate mandatory fields when switching tabs in 'Choose Options' section of Order Guides ( glide.sc.guide.tab.validate) | Validate mandatory fields when switching tabs in the Choose
Options section of order guides:
|
| Render order guide on cart preview and order status page (glide.sc.render_order_guide_column) | Render the order guide on cart preview and order status page. If an item is part of an order guide, the order guide is listed next to the item. If a user attempts to delete an item belonging to an order guide, a confirmation message appears. |
| On an order guide, reset cascading or assigned variable values on an item when
a user goes back using the "describe needs" button
(glide.sc.reset_cascade). Note: This property is supported in
Platform only, not in the portal. |
On an order guide, reset cascading variable values on an item when a user navigates by clicking Describe Needs. |
| On an order guide, reset all variables when cascading variables or assigned
variable values are reset on an item after a user goes back using the "describe
needs" button (glide.sc.reset_cascade_all) Note: This property
is supported in Platform only, not in the portal. |
In an order guide, reset the values of cascading variables and non-cascading values on an item when a user navigates back and forth between the Described Needs and Choose Options screens. If set to false, only the values for the cascading variables are reset. |
| Scriptable Order Guides | |
| During the processing of a scriptable order guide, create a failure record when the JSON payload is empty (glide.sc.sog.empty_payload) | If selected, creates a failure record when the JSON payload is empty during the processing of a scriptable order guide. |
| During the processing of a scriptable order guide, create a failure record when the order guide is inactive (glide.sc.sog.inactive_order_guide) | If selected, creates a failure record when the order guide is inactive during the processing of a scriptable order guide. |
| During the processing of a scriptable order guide, create a failure record when the order guide sys_id is invalid (glide.sc.sog.invalid_order_guide_id) | If selected, creates a failure record when the order guide sys_id is invalid during the processing of a scriptable order guide. |
| During the processing of a scriptable order guide, create a failure record when there is a general JSON parsing error (glide.sc.sog.json_parsing) | If selected, creates a failure record when there is a general JSON parsing error during the processing of a scriptable order guide. |
| During the processing of a scriptable order guide, create a failure record when JSON parameters are missing (glide.sc.sog.mandatory_json_parameters) | If selected, creates a failure record when JSON parameters are missing during the processing of a scriptable order guide. |
| Cart | |
| Enable cloning requests during checkout. Deprecated by sc_layout; if sc_layout is enabled then this property is not used (glide.sc.allow.checkout.clone) | Enable cloning requests during checkout. Note: This property is deprecated when
cart layouts are enabled. |
| List of roles (comma-separated) that can use bulk ordering functionality. Blank means all users (glide.sc.allow.clone.roles) | Roles (comma-separated) that can clone requests for other users. Blank value indicates all users can clone requests. |
| Show the 'Back to Catalog' button on the two-step checkout screen (glide.sc.checkout.twostep.back) | Show the Back to Catalog button on the two-step checkout screen. |
| Use the two-step catalog checkout model (default false) (glide.sc.checkout.twostep) | Use the two-step catalog checkout model. Default value: false |
| Condition under which users may cancel a request (previous property must also be true). For example, current.opened_by == gs.getUserID() || current.caller_id == gs.getUserID() (glide.sc.checkout.cancel.condition) | Condition under which users can cancel a request. Requires Allow ess users the option to cancel their requests from the checkout screen to be True. |
| Allow ess users the option to cancel their requests from the checkout screen. In conjunction with sc_layout feature, if either is set to true the cancel button becomes visible (glide.sc.checkout.cancel) | Enable Employee Self-Service (ESS) portal users the option to cancel their requests from the checkout screen. |
| Use the two-step checkout model when placing a Catalog Order from a Wizard (default true) (glide.expert.checkout.twostep) | Use the two-step checkout model when placing a catalog order from a
wizard: Default value: true |
| List of roles (comma-separated) that can update the "Requested for" widget in the service catalog. Blank means all users. If the user doesn't have privileges to change requested for, they will not have ability to get other user address details (glide.sc.req_for.roles) | List of users with the roles (comma-separated) provided here can request items
for other users. If no role is specified, then the default behavior is defined by
the glide.sc.req_for.roles.default property. For information
about configuring the glide.sc.req_for.roles.default property,
see Configure the default behavior to request items for other users. Controls access to the Requested For widget on the catalog homepage. Users with access to this widget can request items for another person. Users without access can place orders in their own name only. |
| Ordering of matches for the "request for" service catalog widget. Choose fields in the sys_user table (glide.sc.request_for.order_by) | Ordering of matches for the "request for" Service Catalog
widget. Choose fields in the user [sys_user] table. |
| Show the request item number for each line item on the checkout screen (default false). Deprecated by sc_layout; if sc_layout is enabled then this property is not used (glide.sc.checkout.request.number) | Show the request item number for each line item on the checkout
screen: Default value: false Note: This property is
deprecated when cart layouts are enabled. |
| Field name to use for the description column of the checkout form. If blank, the default (short_description) is used (glide.sc.ess.description) | Field name for the description column of the checkout form. If blank, the
default is used: Default value: short_description |
| Additional columns for the "request for" service catalog widget. Choose fields in the sys_user table. Must be semicolon separated (glide.sc.request_for.columns) | Additional columns for the "request for" Service Catalog widget.
Choose fields in the user [sys_user] table. Must be semicolon
separated. |
| Automatically update the delivery address for catalog carts when the details of a users location changes ( glide.sc.auto.cart.address.reset) | Automatically update the delivery address for catalog carts when the user
location details change. If enabled, when changes are made to a user's address, and the user has an active cart, updates the user's address in the cart. If not enabled, the old address is retained in the cart:
|
| When determining the address of a user prioritize the details on an associated location record over the details on the user record itself (glide.sc.prioritise.user.location) | If selected, when determining the address of a user, prioritizes the details on an associated location record over the details on the user record itself. |
| Determines whether 'Order Now' button exhibits new or old behavior. If this property is true, clicking "Order Now" button in the service catalog, only orders the item currently selected, any items saved in user's shopping cart is left untouched for future ordering. Old 'Order Now' feature is deprecated, 'Order Item' button is deprecated too (glide.sc.enable_order_now) | Determines whether the Order Now button exhibits new or old behavior. If this property is true, clicking Order Now in the service catalog only orders the item currently selected. Any items saved in the shopping cart are left untouched for future ordering. The legacy Order Now feature and the Order Item button are deprecated. |
| List of roles (comma-separated) that can use the quantity selector in the shopping cart. Blank means all users (glide.sc.allow.quantity) | List of roles (comma-separated) that can use the quantity selector in the shopping cart. Blank means all users. |
| Enable removal of inactive catalog items from cart ( glide.sc.remove_inactive_cat_items_from_cart) | Enable removal of inactive catalog items from cart. If enabled, automatically removes all deactivated catalog items from the shopping cart. Avoids users ordering items which are placed in the cart while active and are then made inactive:
|
| Use the sc_layout driven cart macros (default: true) ( glide.sc.use_cart_layouts) | Use the sc_layout driven cart macros. Activates the new cart layout mechanism, which enables customization of cart and checkout-related widgets and pages without the need to own the UI macros or pages:
|
| Show tasks related to requests on the order status page (the screen you see in the service catalog after a successful order is placed) (glide.sc.checkout.task.display) | Show tasks related to requests on the Order Status page, the screen that you see in the service catalog after a successful order is placed. |
| Round all delivery plans > 1 day to the nearest day (true) or display the precise time (false) (glide.sc.round.delivery.times) | Round all delivery plans > 1 day to the nearest day (true) or display the precise time (false). |
| Request Fulfillment | |
| Prevent changes to requested item quantity when approved (except for catalog_admin users) (glide.sc.restrict.quantity.changes) | Prevent changes to the requested item quantity (except for catalog_admin users). |
| Show the current pending approver's name in the stage widget mouseover (glide.sc.approval.hover) | Show the current pending approver's name in the stage widget mouseover. |
| Service catalog tasks approval engine (glide.approval_engine.sc_task) | Service Catalog Tasks approval engine. |
| Audit changes to service catalog variables (glide.sc.audit.variables) | Audit changes to Service Catalog variables. |
| Hide the border and background in variable editor ui (glide.sc.hide_variable_editor_background) | If selected, hides the border and background in variable editor UI. The default value is false. |
| Use delivery task name instead of short_description for the delivery plan summarizer field. Default is false (uses the short_description) (glide.sc.delivery_summary.name) | Use the delivery task name instead of the short description for the delivery
plan summarizer field: Default value: false (uses the short description) |
| Render variables on a request item as they appear on the order panel, followed by the delivery plan variables (true), or merge the two based on their order values (false) (glide.sc.variable.snapshot) | Render variables on a request item as they appear on the order panel, followed by the delivery plan variables (true), or merge the two based on their order values (false). |
| Service Catalog Requests approval engine (glide.approval_engine.sc_request) | Service Catalog requests approval engine. |
| Search | |
| List of class names for catalog items that don't have the search field displayed ( glide.sc.item.cannot_show_search) | List of class names for catalog items that don’t have the search field
displayed:
|
| Allow empty service catalog searches (glide.sc.search.allow_empty_search) | If selected, an empty query in the search bar displays all items. This query is performance-heavy. |
| List of roles (comma-separated) that can search the service catalog. Blank means all users (glide.sc.can_search) | List of roles (comma-separated) that can search the Service Catalog. Blank means all users. |
| Show breadcrumbs for the categories associated with items when they are displayed in browse and search listings (glide.sc.show_listing_breadcrumbs) | If selected, display breadcrumbs for the categories associated with items when they are displayed in browse and search results. |
| Service catalog searches return items in inactive categories ( glide.sc.search.disabled_cats) | Service Catalog searches return items in inactive categories.
Search results can include catalog items in non-accessible categories, as specified by the active flag or by security constraints:
|
| List of catalog sys_ids (comma-separated) that are excluded from catalog item search (glide.sc.search.exclude_catalogs) | List of catalog sys_ids (comma-separated) that are excluded from catalog item search. |
| Number of service catalog matches returned for global searches (glide.sc.search.rowcount) | Number of the service catalog matches returned for global searches. Limits the number of results returned by a catalog search to improve search performance. |
| Specify whether search suggestions should be enabled (glide.sc.search.suggestions) | Specify whether search suggestions are enabled:
|
| Security | |
| Use "User Criteria" to define access to catalog items and categories ( glide.sc.use_user_criteria) | Use user criteria to define access to catalog items and categories.
Entitlements are not honored if set to true:
|
| Enable both "User Criteria" and "Entitlement" related lists for catalog items and categories when migrating from entitlements ( glide.sc.user_criteria_migration) | Enable User Criteria related lists for catalog items and categories when
migrating from entitlements. Set to true to display the user criteria related lists without needing to switch to user criteria functionality:
|
| List of roles (comma-separated) that can override normal entitlement checking inside the catalog. A role of "itil" means that the itil role can order any catalog item, even one protected by entitlement restrictions (glide.sc.entitlement.override) | List of roles (comma-separated) that can override normal entitlement checking inside the catalog. A role of "itil" means that the itil role can order any catalog item, even one protected by entitlement restrictions. |
| List of roles (comma-separated) that override entitlements so that they can view any category within the service catalog (glide.sc.category.canview.override) | List of roles (comma-separated) that override entitlements to enable viewing of
any category within the Service Catalog. Default value: admin and catalog_admin |
| Pricing | |
| Append pricing information to option labels (glide.sc.enhance.labels) | Append pricing information to option labels. This is also applicable in Service Portal. |
| List of class names for catalog items that don't show the price in listings (glide.sc.item.cannot_show_price) | List of class names for catalog items that do not show the price in listings. |
| When to show prices and sub-totals on the service catalog cart (overrides sc_layout record settings) (glide.sc.price.display) | When to show prices and sub-totals in the service catalog cart. |
| When set to true then the two script includes CatalogPriceCalculator and CatalogRecurringPriceCalculator are used generate prices (enabling custom functionality) (glide.sc.use_custom_pricegenerator) | When set to true, the script includes,
CatalogPriceCalculator and
CatalogRecurringPriceCalculatorare used to generate prices,
which enables custom functionality. To use your own price calculation logic, set this property to Yes. Then edit the calcPrice method inside the CatalogPriceCalculator and CatalogRecurringPriceCalculator script includes, using your own price calculation algorithm:
|
| Portal | |
| Show order confirmation pop-up in checkout process (glide.sc.sp.twostep) | If selected, displays the order confirmation window during the two-step checkout process inService Portal. |
| Use Cart V2 widget in Header Menu widget (glide.sc.portal.use_cart_v2_header) | If selected, the Cart V2 (SC Shopping Cart widget (ID: sc-shopping-cart-v2)) widget is enabled in the Header Menu widget of Service Portal. |
| Virtual Agent This section is visible only when you activate the Service Management Virtual Agent Topic Blocks plugin (com.glideapp.cs.sm_topic_blocks) . |
|
| Specifies the upper limit for the number of questions beyond which the item doesn’t support conversational requests, default value of the property is 10 (glide.sc.conversational.request.question.limit) | Maximum number of questions for a catalog item for it to be eligible for request submission in the conversation mode in Virtual Agent. |
| Mobile | |
| Catalog category sort option in Now Mobile (glide.sc.mobile.category.order_by) | Sort option for categories in Now Mobile.
|
| Include 'Desktop only' Items in Now Mobile (glide.sc.mobile.include_desktop_only_items) | Option to include the catalog item with Availability set to Desktop only in Now Mobile. |
| Catalog item classes not available in Now Mobile (comma separated list) (glide.sc.mobile.item_class_not_supported) | Catalog item types to exclude in Now Mobile. For example, sc_cat_item_content, sc_cat_item_producer |
| Experience for items not available in Now Mobile (glide.sc.mobile.unsupported_discover) | Option to define the non-availability behavior of a catalog item. Possible options:
Note:
|
| Primary color for buttons in the catalog request experience in Now Mobile (glide.sc.mobile.primary_color). If Next Experience is turned on, the property will be ignored. | Color for buttons in the catalog request experience. |
| Other | |
| Log all client-side actions on variable ( glide.sc.log.variable_actions ) | If set to true, captures the variable log in the Variable Action Logger window:
|
| Use links for breadcrumbs rendered in service catalog pages accessed via a CMS site ( glide.sc.use_breadcrumb_links.cms) | Use links for breadcrumbs rendered in Service Catalog pages
accessed via a CMS site. Enables users with the CMS administrator (content_admin) role to choose whether service catalog breadcrumbs are displayed with or without links for greater navigation control:
|
| Enable the ui policies related to variable set to be run first ( glide.sc.ui_policy.variable_set_run_first) | Enable the UI policies related to the variable set to run first. If enabled,
UI policies related to the variable set are run first, then the UI policies on
items:
|
| The maximum number of orphan sc_item_option records to delete when any sc_req_item record is deleted (sc_orphan_item_option_delete_limit) | Maximum number of orphan sc_item_option records to delete when any sc_req_item record is deleted. |