Administration Guide

Set Up Service Requests for the Catalog

On this page

A Service Catalog item raises a Service Request through its request fulfillment. Each request fulfillment names a Service Request Create Action, a workflow action that creates the request (see Workflow Overview). Submitting an item runs the Create Action of the item's fulfillment, and the new Service Request is pre-filled with the catalog item. Nothing on the item record itself makes the item orderable: which Create Action an item runs is decided only by its fulfillment, so to change what an existing item does, change that fulfillment or the Create Action behind it.

On the item's side, the one requirement is a request fulfillment that names an existing Service Request Create Action; the other conditions are listed under When an item can be submitted. A new catalog item can reuse an existing request fulfillment, and a new request fulfillment can run an existing Create Action: several fulfillments can name the same Create Action. For a new catalog offering, we recommend a set of three that belong together:

  1. A Service Request category for the offering: a category of the Service Request class, not a catalog category.
  2. A Service Request Create Action whose template sets that category (see Set up the Create Action for a Service Request).
  3. A request fulfillment that runs the Create Action and has the same name as the Create Action (see Create a request fulfillment).

Catalog items are grouped into catalog categories. The categories form a tree of their own, and one item can belong to several categories. Categories are managed in the Web App, on the Service Catalog page, with the edit right on Service Catalog items, and an item is attached to categories on its Categories tab. Both procedures, and the item record itself, are in Service Catalog. How the Self Service Portal presents the catalog is covered in Request a Service.

When an item can be submitted

The list of items that can be submitted keeps an item only when all of the following are true:

  • the item's request fulfillment names a Create Action that exists,
  • the Submit Request action is available for the item's type and status and for the user's roles, and
  • the condition of the Submit Request action passes for the item.

A category with no remaining item is dropped from that list.

In the Settings App

Set up the Create Action for a Service Request

A class's Create Actions are listed on the Create Actions node under the class's Workflow > Actions node, in the Workflow and Business Logic group of the Settings App. A class's Workflow node requires that class's own administrative right, the right that allows managing the class's business logic. Create Actions are edited in one dialog, captioned Create Action. For a Service Request, the action is always saved as an ordinary Create Action, never as a subordinated or recurring one, and the Available for options are not shown. The Condition tab, which holds the Roles list and Additional criteria, is hidden for Service Requests.

  1. Go to Workflow and Business Logic, expand the section that holds the Service Request class, and under that class select Workflow > Actions > Create Actions.
  2. Create or open the Service Request Create Action that the fulfillment is to run.
  3. On the General tab, set Name, Caption, Hint, and Description, and select or clear Enabled.
  4. Optionally, set the action's icon in the Icon: group, which has the buttons Change..., Set Default, and Clear, and Copy and Paste on its pop-up menu:
    • Change... opens a file dialog for BMP, ICO, and PNG files. The file's content decides whether it is accepted: a file that is not a real PNG, ICO, or BMP image is refused with an error.
    • Paste takes a picture from the clipboard and stores it as a PNG.
    • Set Default returns to the built-in icon, and Clear leaves the action without an icon.
    • Once an ICO file has been loaded in the window, a picture chosen or pasted after it is shown, but the ICO file is what is saved.
  5. On the Template tab, choose an existing template or define a custom template to be used only for this action. The template's values are applied when the Service Request is created.
  6. On the Form tab, keep the full form or select another form. A new Create Action is set to the full form; while the full form is selected, the form definition is read-only and the button for a custom form reads Use Custom.
  7. Optionally, on the Programming tab, add the operations that the action runs. Operations are added from the New menu of the operations list:

    • Choosing an operation adds a row after the focused row, or as the first row inside a focused IF, ELSE IF, or ELSE group, and, for most operations, opens a window captioned with the operation's name. Cancel in that window removes the row again.
    • The window shows Object Class: with the name of the class the operation works on (inside a Create Object or Act on Related Object block, that block's class, with a warning line), the operation's own controls, the Enable operation check box, which is selected by default, and OK and Cancel. OK stays unavailable until the operation's required values are set.
    • An operation saved with Enable operation cleared is skipped when the action runs.
    • To change an operation later, double-click its row or select it and press Enter. Rows are not edited in place.

    Each operation is described in Operations Reference. 8. Save the action.

Order the Create Actions

The Create Actions node carries the Display Order... command, which opens the Display Order window with the class's Create Actions. Move the selected actions with Move Up and Move Down (Ctrl+Up and Ctrl+Down) or by drag and drop; several rows can be selected at once. Close the window with OK to keep the new order, or with Cancel. Create Actions are not grouped in this window.

Create a request fulfillment

Request Fulfillments is a classification list of the Service Catalog Item class, and it is the only lookup in the Settings App whose editor carries a workflow action. The list shows each fulfillment with its name, whether it is active, and the name of the Create Action it runs. A fulfillment whose Create Action no longer exists shows an empty Create Action.

  1. Go to Workflow and Business Logic > Service Management > Service Catalog Items > Classification, and open the Request Fulfillments page.
  2. Add a fulfillment or open an existing one.
  3. Enter the fulfillment's name. The name is not tied to the Create Action; we recommend using the name of the Create Action that the fulfillment runs.
  4. In Service Request Create Action, select the Create Action to run when an item that uses this fulfillment is submitted.
  5. Select or clear Active. Clearing Active retires a fulfillment without deleting it.
  6. Click OK.

Each Service Catalog item names one request fulfillment. The item record is covered in Service Catalog.

A Create Action that a request fulfillment names cannot be deleted. The delete is refused with the message "Unable to delete this Action because it is used in the Request Fulfillment "<name>"."

In the Admin Center

Create a request fulfillment

Request fulfillments can also be edited on the Request Fulfillments classification page of the Admin Center. The list shows the Create Action of each fulfillment in a column of its own.

  1. On the Request Fulfillments page, add a fulfillment, or open an existing one from its link in the list. The fulfillment opens in an edit drawer.
  2. Enter the fulfillment's name. The name is required and can be up to 100 characters long.
  3. In Create Action, select the Create Action to run when an item that uses this fulfillment is submitted. The field can be cleared, and the page does not require a value; an item whose fulfillment names no Create Action is not offered for submission.
  4. Select or clear Active.
  5. Click Ok to save the fulfillment.