Thank you for your feedback.
Form temporarily unavailable. Please try again or contact to submit your comments.

Create an order guide

Log in to subscribe to topics and get notified when content changes.

Create an order guide

You can create an order guide with a two-step or three-step ordering process.

About this task

To create an order guide:


  1. Navigate to Service Catalog > Catalog Definition > Order Guides.
  2. Click New.
  3. Fill in the fields as appropriate.
    Table 1. Order guide
    Field Description
    Name Order guide name that appears in the catalog.
    Active Check box to indicate whether the order guide is active or not.
    Category Category heading under which the order guide appears in the catalog.
    Two step Check box to enable two step ordering instead of the default three-step ordering, omitting the final step. With two step ordering, selecting Check out submits the request immediately, then displays the order confirmation screen. This is not applicable for Service Portal.
    Icon A 16x16 pixel image to appear as an icon beside the order guide name in the catalog. If no image is uploaded, the default icon appears beside this order guide.

    To use your own default icon, upload an image, overwriting the image stored in images/service_catalog/generic_small.gif.

    Cascade variables Check box to select whether the variables used cascade, which passes their values to the ordered items. If this check box is cleared, variable information entered in the order guide is not passed on to ordered items.
    Ordered Item Link Link to more information about an ordered item. Select a predefined link item to appear on the ordered item screen. Customers can click the link to access more information. This is not applicable for Service Portal.
    Roles Roles that users must have to access this order guide.
    Short description Summary of the order guide purpose.
    Description Description that appears on the first page of the order guide. Apply formatting with the HTML editor.
    Meta Comma-separated list of tags used to search for the order guide. See Configure keyword search for catalog items.
    Hide on Service Portal If selected, the order guide is not available on Service Portal.
    Picture [Optional] Image of the item.
    Order to cart Check box allowing users to add order guides to their cart, then continue shopping rather than checking out immediately. This is not applicable for Service Portal.
    Note: This setting only works when the Two step check box is also set to true.
    Portal Settings
    Use these settings to configure the order guide behavior in Service Portal.
    Request method Setting that controls the label displayed for the Order Now button and the order submission experience.
    • Order:
      • Button label: Order Now
      • Confirmation dialog box: Displayed
      • Delivery information: Editable
      Note: This is the default setting.
    • Request:
      • Button label: Request
      • Confirmation dialog box: Displayed
      • Delivery information: Not displayed.

      This setting can be used in scenarios such as a code access request where the delivery information is pre-determined.

    • Submit:
      • Button label: Submit
      • Confirmation dialog box: Not displayed
      • Delivery information: Not displayed

      This setting can be used in scenarios such as reset password request where no further request information is required.

    Hide 'Add to Cart' If selected, the Add to Cart button is not displayed for the order guide. If the Show Add to Cart instance option of the widget is set to false, then this setting is ignored.

    This setting is selected by default if the Request method is Request or Submit.

    For upgrade scenarios, if the No cart field is selected in Platform, run the CatalogPortalSettingsMigration script include to update this setting to the Hide 'Add to Cart' field in the Portal Settings tab.

    Show Include Toggle If selected, a toggle is displayed for each catalog item in the Choose Options section in Service Portal. You can click this toggle to include or exclude the catalog item from the order guide request.

    For zboot customers, this option is selected by default for existing order guides in the demo data and new order guides.

    For upgrade customers, this option is selected by default only for new order guides.

  4. Right-click the form header and click Save.
  5. In the Rule base related list, define the rules that determine which items are included in an order.
  6. (Optional) In the Variables related list, define any variables required.