Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Service catalogs allow you to create an ordered structure of internal and external services provided to consumers. The "out-of-the-box" solution contains at least one service catalog for the Self-Service Portal. Customize it and offer your customers the most relevant products. Provide a way to raise incidents and requests in a standardized, enterprise-wide way.
The Service Catalog architecture implements Record Extended Model principles allowing customizing categories and request templates with minimal effort.
The scheme below illustrates service catalog working principles.
Element | Description |
---|---|
Catalog | A high-level entity that groups all other items such as categories and request models. Catalogs simplify self-service operations for end-users. |
Category | A group of elements that shares some common attributes. |
Request Model | A template used to raise requests and other task objects. It can be extended with the Record Extended Model functionality. |
To configure a service catalog, please follow a simple procedure:
- Create a service catalog.
- Create service catalog categories.
- Create catalog request models.
- Extend request models with record attributes.
- Make changes to portal configuration (create and configure portal nodes).
All these steps are described below.
Anchor | ||||
---|---|---|---|---|
|
A service catalog record is the highest-level entity that groups all other elements (categories, subcategories, items).
Tip |
---|
Role required: catalog_admin, admin. |
To create a new service catalog, complete the steps below:
- Navigate to Request Model Catalog → Catalogs.
- Create New and fill in the fields.
- Click Save or Save and Exit to apply the changes.
Service catalog form fields
Field | Mandatory | Description | ||
---|---|---|---|---|
Name | Y | Specify a service catalog name. | ||
Description | N | Specify a service catalog description. | ||
Managers | N | Specify authorized users to make any changes to the catalog configuration. You can select more than one user in this field.
| ||
Available for Use | N | Select this checkbox to display this service catalog on the portal. |
Note |
---|
To support multiple service catalogs displayed in a single service portal instance, configure a dedicated node for each catalog. These nodes should define a displayed link to this catalog in the portal header and in the service catalog card of the portal main area. Otherwise, the created service catalog is not displayed on the service portal and is only accessible via a direct link. |
Anchor Catalog Category Catalog Category
Create a catalog category
Catalog Category | |
Catalog Category |
A catalog category is an entity that contains request models of a similar theme like a folder in a file system. For example, you can create a category "IT Assistance" and then create request templates "New Laptop Request", "Equipment replacement" in this category. Thus, this category is a container for these request templates.
The category hierarchy can be multi-level, so you can create an extensive structure by setting up parent-child relationships for categories.
To create a catalog category, complete the steps below:
- Navigate to the catalog record for which you need to create a category record.
- In the Related Lists area, select the Categories tab.
- Click New and fill in the fields.
- Click Save or Save and Exit to apply the changes.
Info |
---|
You can also create a catalog category from scratch. To do this, navigate to Request Model Catalog → Categories. |
Catalog category form fieldfields
Field | Mandatory | Description |
---|---|---|
Name | Y | Specify a category name. |
Description | N | Specify a category description. |
Order | N | Enter a number to define the category order in the catalog. The categories are sorted in ascending order. |
Catalog | Y | Specify a catalog that this category relates to. If the category is created from related lists of any existing catalog, this field is automatically populated with the catalog name. |
Parent Сategory | N | Specify a parent category if you create a multi-level category structure. If a category is created from any other category, this field is automatically populated with the parent category name. If a value is not specified, then this category has the highest level. |
Image | N | Add an image for the decoration of a portal category record. |
Available for Use | N | Select this checkbox to make this category displayed on the portal. |
Note |
---|
Note that a category is not displayed within the service catalog in the following cases:
|
Anchor | ||||
---|---|---|---|---|
|
Request models are templates based on which a new request object is created. Request models can be extended with the Record Extended Model functionality.
To create a request model, complete the steps below:
- Navigate to a category record for which you need to create a request model.
- In the Related Lists area, select the Request Models tab.
- Click New and fill in the fields.
- Click Save or Save and Exit to apply the changes.
Info |
---|
You also can create a catalog category from scratch. To do this, navigate to Request Model Catalog → Request Models. |
Request model form fieldfields
Field | Mandatory | Description |
---|---|---|
Name | Y | Specify a request model name. |
Description | N | Specify a request model description. |
Order | N | Enter a number to define the items order in the catalog. Items are sorted in ascending order. |
Table | Y | Specify a table to register incoming requests in it. It can be, for example, the Task table or other tables extending it. |
Category | Y | Specify a parent category for this model. If a category is created from the related list, this field is automatically populated with the category name. |
Post-Registration Action | N | Select what happens after the request based on this model is submitted. Available options:
|
URL | N | Specify URL to redirect after request submitting. This field appears if the Redirect on the selected page option was selected above. |
Image | N | Add an image for the decoration of a portal request record. |
Available for Use | N | Select this checkbox to display requests based on this model on the portal. |
Service | N | Specify a service for which this request model is intended for. It can be useful for service-based segregation within one service catalog (one request form for the Email service, another one for the Website service, and so on). |
Anchor Extending request model Extending request model
Extend a request model with record attributes
Extending request model | |
Extending request model |
A request models contain a limited set of predefined attributes. You may need to extend it, depending on the task you need to complete.
For example, you need to add a Comment field to the model so that it should map to the Additional Comments field in the record.
To do this, complete the steps below:
- Navigate to a request model record which you need to extend with an attribute.
- In the Related Lists area, select the Attributes tab.
- Click New and fill in the fields.
- Click Save or Save and Exit to apply the changes.
Excerpt Include Record Extended Model Record Extended Model nopanel true
Anchor Configure portal Configure portal
Configure a portal
Configure portal | |
Configure portal |
You can implement more than one service catalog in your company infrastructure. To bind these catalogs on the Self-Service Portal, set up and configure a dedicated portal node for each catalog.
Info |
---|
The "out-of-the-box" solution has a preconfigured portal node that contains all necessary settings. You can use it as a template for your custom nodes. |
Portal node configuration
Field | Description | Out-of-the-Box value | ||
---|---|---|---|---|
Portal | Specify a portal for which this node is created. | Self-Service Portal | ||
Page ID | Specify a portal page that contains a catalog template. | Service Catalog (Path Name: sc) | ||
Item Table | Specify a table that contains catalog items. | Request Model | ||
Item Parent Column | Specify a column in the table defined above that contains the information about which category is parent for items. | Category | ||
Category Table | Specify a table that contains catalog categories. | Category | ||
Category Parent Column | Specify a column in the category table defined above that contains the information about which category is the parent for others. | Parent Category | ||
Category Item Condition | Specify a condition that must be met to display a catalog category item. | Available for Use is Yes AND Order ascending | ||
Category Condition | Specify the condition that must be met to display a catalog category.
| Catalog is Service Catalog AND Available for Use is Yes AND Order ascending | ||
Item Page | Specify a portal page that contains a template for the catalog request. | Service Catalog Element Page |
Anchor | ||||
---|---|---|---|---|
|
As mentioned above, it is necessary to configure a dedicated node for each catalog. To do this, complete the steps below:
- Navigate to Tree Structures → Nodes.
- Click New and fill in the fields.
- Click Save and Save and Exit to apply the changes.
Excerpt Include | ||||||
---|---|---|---|---|---|---|
|
Access control
You can configure access tp either a catalog category or a catalog request model using the User Criteria engine. Thus, you can set flexible conditions and vary catalog items displayed to the audience.
How it works
An administrator defines access, as described below, to catalog elements (categories and request models) allowing or denying access for certain audience segments. User criteria are used to separate segments from each other.
When a user navigates to a service catalog, they are processed by the User Criteria engine according to the pattern below to decide whether this user is allowed or denied to display specified catalog elements.
Configure access to a category
To configure category access, complete the steps below:
- Navigate to the category you need to configure.
- In the Related Lists area, select the User Criteria tab.
- Click New and fill in the fields.
- Click Save or Save and Exit to apply the changes.
Tip |
---|
You can also create a category access configuring record from scratch. To do this, complete the steps below:
|
Category User Criteria form fields
Field | Mandatory | Description |
---|---|---|
Category | Y | Specify a category to which you need to configure access |
Criterion | Y | Specify a user criteria record to be met. |
For Users by this Criterion | Y | Specify an access option. Available options:
|
Configure request model access
To configure request model access, complete the steps below:
- Navigate to the request model you need to configure access.
- In the Related Lists area, select the User Criteria tab.
- Click New and fill in the fields.
- Click Save or Save and Exit to apply the changes.
Tip |
---|
You can also create a request model access configuring record from scratch. For this, complete the steps below:
|
Field | Mandatory | Description |
---|---|---|
Request Model | Y | Specify a request model to which you need to configure access. |
Criterion | Y | Specify a user criteria record to be met. |
For Users by this Criterion | Specify an access option. Available options:
|
Table of Contents | ||||||
---|---|---|---|---|---|---|
|