Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Service catalogs allow creating you to create an ordered structure of internal and external services provided to consumers. Generally, The "out-of-the-box" solution contains at least one service catalog is included in the for the Self-Service Portal delivery. Customize it and offer your customers the most actual relevant products. Provide a way to raise incidents and requests in an a standardized, enterprise-wide standardized way.
Service Catalog architecture implements 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 uniting that groups all other items such as categories and request models. Catalogs allow facilitating simplify self-service operations for end-users. |
Category | Element group joined with A group of elements that shares some common attributeattributes. |
Request Model | A template used to raise requests and other task objects. It can be extended with the Record Extended Model functionality. |
Image RemovedImage Added
To configure a service catalog, please follow follow a simple procedure:
- Create a service a service catalog itself.
- Create service catalog categories.
- Create catalog request models.
- Extend request models with record attributes.
- Configure request models forms.
- Make changes to Make adjustments into portal configuration (create and configure portal nodes).
All these steps are described below.
Anchor | ||||
---|---|---|---|---|
|
Create a service
catalogscatalog
Service A service catalog record is the highest-level entity aggregating that groups all other items below elements (categories, subcategories, items).
Note |
---|
To support multiple service catalogs displayed within one service portal instance, it is necessary to configure dedicated node for every catalog. These nodes should define displayed link to this catalog in the portal header, also in the service catalog card in the portal main area. Otherwise, the service catalog created will be not displayed on the service portal and will be accessible only via direct link. |
Tip |
---|
Role required: catalog_admin, admin. |
To create a new service catalog, please 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 changes.
Service catalog form fields
Specify users authorized to make any changes to the catalogs configuration. You can select more than one user in this field.
Note |
---|
Users responsible for specified catalog management should be granted with the catalog_manager role. |
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. |
Info |
---|
You can add translations to the Name and Description fields. |
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
Creating Catalog Category | |
Catalog Category |
Create a catalog
categoriescategory
Catalog A catalog category is an entity allowing to contain that contains request models of a similar theme together, like a folder in a filesystemsubject. For example, you can create a category "IT Assistance" , and after that, then create models for request like templates "New Laptop Request", "Equipment replacement" in this category. SoThus, this category will be is a container for these request modelstemplates.
Categories The category hierarchy can be multi-level, so you can create really an extensive structure by setting up category relationships ("parent" and "child")parent-child relationships for the categories.
To create a catalog category, please complete the steps below:
- Navigate to a the catalog record for which you are going need to create a category record.
- Scroll down to In the Related Lists area and click New in the , select the Categories tab.
- Fill Click New and fill in the fields.
- Click , after that, click Save or Save and Exitexit to apply the changes.
Info |
---|
You can also create a catalog category from scratch. To do thisso, please navigate to Request Model Catalog → Categories. The next steps are the same as described above. |
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 the 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 |
гse | N | Select this checkbox to make this category displayed on the portal. |
Info |
---|
You can add translations to the Name and Description fields. |
Note |
---|
Please note Note that a category is not displayed within the service catalog in the following cases below:
|
Anchor | ||||
---|---|---|---|---|
|
Create a request
modelsmodel
Request models are templates basing on which a used for creating new request object can be createdobjects. Request models can be extended with the Record Extended Model functionality.
To create a request model, please complete the steps below:
- Navigate to a category record for which you are going need to create a request model.
- Scroll down to In the Related Lists area and click New in the , select the Request Models tab.
- Fill Click New and fill in the fields.
- Click , after that, click Save or Save and Exitexit to apply the changes.
Info |
---|
You also can create a catalog category from scratch. To do thisso, please navigate to to Request Model Catalog → Request Models. The next steps are the same as described above. |
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 a related list, this field is automatically populated with the category name. |
Post-Registration |
action | N | Select what |
happens after the request |
is submitted according to the model. Available options:
| ||
URL | N | Specify the URL to redirect after request submitting. This field appears if the Redirect on the selected page option was selected above. |
The default value is view_task?table_name={table_name}&record_id{record_id}. | ||
Image | N | Add an image for the decoration of a portal request record. |
Available for |
use | N | Select this checkbox to |
display the requests based on this model |
on the portal. | ||
Service | N | Specify a service |
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). |
Info |
---|
You can add translations to the Name and Description fields. |
Extend a request model with record attributes Anchor
Extending request modelExtending request model Extending request
models with record attributesExtending request model | |
Extending request |
model
model |
A Basically, request models contain a limited attribute set of predefined attributes. You may need to can extend it relying on the task you need to handleupon your task requirements.
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 perform thisdo so, please complete the steps below:
- Navigate to a request model record which that you are going need to extend with an attribute.
- Scroll down to the In the Related Lists area and click New in the , select the Attributes tab.
- Fill Click New and fill in the fields.
- Click , after that, click Save or Save and Exitexit to apply the changes.
Excerpt Include | ||
---|---|---|
|
Specify the target field to map the attribute value after the record is created. This option allows nimble transferring of the attribute values to fields.
Note |
---|
Please note that if the target field is mandatory, then the value is saved before it is processed by server validation engine. Also, if the target field is mandatory, it should be not displayed on the form, otherwise the client validation engine may hamper the record saving. |
Specify a default value that will be populated to the field when creating a new record. This field may be specified by a JavaScript scenario as well.
This field appears only when the Use Dynamic Default attribute is selected.
Select the script from the Dynamic Default Values (sys_default_value_dynamic) dictionary, so its execution result will be automatically calculated and entered into this field; this value will be the default value for the column specified.
- The script must be preliminary created in the Dynamic Default Values (sys_default_value_dynamic) dictionary; otherwise, you will not be able to choose it.
- You can choose only active scripts (the Active attribute is selected).
|
Info |
---|
You can add translations to the Title field. |
Configure request model form
You can configure the elements of the request model in the Model Form Elements related list on the model form. By default, this related list is not added to the form, so you need to add it manually.
Info |
---|
Use Sort acsending option for the Position column in the related list to view the elements in the same order as they are displayed on the request model form. |
To change the order of the displayed attributes, perform the following steps:
- Navigate to Request Model Catalog → Request Models.
- Open the request model you need.
- In the Related Lists area, select the Model Form Elements tab.
Arrange the attributes by changing the value in the Position field. The attributes are displayed on the form in the ascending order.
To add new elements to the request model layout (such as splits), perform the following steps:
- Navigate to Request Model Catalog → Request Models.
- In the Related Lists area, select the Model Form Elements tab.
- Click New and fill in the fields.
- Click Save or Save and exit to add the element.
Model Form Element form fields
Field | Mandatory | Description | ||
---|---|---|---|---|
Container | Y | Specify a previously created request model. If the element is created from the related list, the field is populated automatically. | ||
Position | Y | Define the order of the element on the form. The elements are displayed on the form in the ascending order. | ||
Block element | Y | Specify the type of the element. Available options:
| ||
Block title | N | Specify the title of the group of fields. The title is displayed above the attributes group on the relevant page of the Self-Service Portal.
|
Example of request model form configuration
Attribute/Block element | Position | Description | ||
---|---|---|---|---|
Begin | 15 | The element opens the block and contains the block title. | ||
Attribute 1 | 20 | The first request model attribute. | ||
Split | 25 | The element splits the block into columns. It allows you to place two attributes in a row. | ||
Attribute 2 | 30 | The second request model attribute. | ||
End | 35 | The element closes the block. Further elements belong to another block, they are not placed in the same row. | ||
Collection attributes 1, 2 | 40 | The attributes of the collection used in the request model.
|
Image Added
Anchor Configure portal Configure portal
Configure a portal
Configure portal | |
Configure portal |
You can implement several service catalogs 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 this node is created for. | Self-Service Portal |
Page | Specify a portal page that contains a catalog template. | Service Catalog (Path Name: sc) |
Item table | Specify a table that contains the 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 the items. | Category |
Category table | Specify a table that contains the 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. |
As mentioned above, you can implement more than one service catalog within your company infrastructure. To bind these catalogs within your Self-Service Portal, please note the following: every single catalog requires dedicated portal node to set up and configure.
Info |
---|
For your convenience, a preconfigured portal node containing all necessary settings is included into platform delivery. You can use it as a sample for your customized nodes. |
Portal node configuration
Field | Description | Out-of-the-Box value | ||
---|---|---|---|---|
Portal | Specify the portal for which this node is created. | Self-Service Portal | ||
Page ID | Specify a portal page containing catalog template. | Service Catalog (Path Name: sc) | ||
Item Table | Specify a table containing catalog items. | Request Model | ||
Item Parent Column | Specify the column in the table defined above containing information about which category is parent for items. | Category | ||
Category Table | Specify the table containing catalog categories. | Category | ||
Category Parent Column | Specify the column in the category table defined above containing 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 a condition that must be met to display a catalog category.
Catalog is Service Catalog AND | Available for Use is Yes AND Order ascending | ||
Item PageCategory condition | Specify | Service Catalog Element Page |
As mentioned above, it is necessary to configure a dedicated node for every catalog. To perform this, please complete the steps below:
- Navigate to Tree Structures → Nodes.
- Click New and fill in the fields.
- Click Save and Save and Exit to apply changes.
See the screenshot below as the form filling example.
Image Removed
Node fields
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 so, 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 | ||||||
---|---|---|---|---|---|---|
|
Info |
---|
You can add translations to the Title field. |
Add translations
In the current version, the Translations related list is not displayed in the Catalog, Category and Request Model forms. However, a translation in the current system language is automatically created for each new record. To add translations into other languages, complete the following steps:
- Navigate to System Localization → System Translations.
- Open the automatically created translation record. Find it by the record ID or by the translation text.
- Enter the required values into the Language and Value fields. Don't save the record.
- In the burger menu, click Make a copy. Click OK in the warning window that appears.
- Repeat for other languages, if required.
To add translations to a REM attribute, complete the following steps:
- Navigate to the REM attribute record you need to translate.
- Scroll down to the Translations related list and click New.
- Fill in the fields and click Save or Save and exit to apply the changes.
- Repeat for other languages, if required
Node title. This field can be populated in any language supported by the platform.
Info |
---|
In our example, you can specify the Service Catalog title. |
Select a previously created tree containing information about the structure.
Info |
---|
To display the catalog in the portal header, select the Portal Header Menu tree included. |
Node nesting level. This field is populated automatically.
This parameter shows on which nesting level this item is located.
Extra attributes tab
Specify an URL for an item. In this field, you can specify either absolute or relative URL (relative to the current portal referring to the tree to which the current node is assigned):
Absolute URL: https://instance.example.com/portal/profile
Relative URL: /profile
Specify the icon for an item by attaching it from your device.
Image Removed
- .
Access control
You can configure access (allow or deny) either to to either a catalog category or to a catalog request model using the User Criteria engine. So Thus, you can set flexible conditions and vary catalog items displaying displayed to the audience by defining flexible conditions.
How it works
Administrator An administrator defines the access, as described below, to the catalog elements (categories and request models) by allowing or denying access to some for certain audience segments. To segregate segments amongst themselves, user User criteria are used to separate segments from each other.
After that, when When a user navigates to a service catalog, it he or she is processed by the User Criteria engine against according to the pattern below to make a decision, if decide whether this user is allowed or denied to display the specified catalog elements.
Image RemovedImage Added
Configure access to a category
accessTo configure a category access, please complete the steps below:
- Navigate to the category you need to configure.
- Scroll down to In the Related Lists area and click on , select the User Criteria tab.
- Click New and fill in the fields.
- Click Save or Save and Exitexit to apply the changes.
Tip |
---|
You can also create a category access configuring record from scratch. For thisTo do so, please 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 User Criteria to matcha user criteria record to be met. |
For Users users by this Criterioncriterion | N | Specify the an access option. Available options:
|
Configure request model access
To configure request model access, please complete the steps below:
- Navigate to the request model you need to configure access.
- Scroll down to In the Related Lists area and click on , select the User Criteria tab.
- Click New and fill in the fields.
- Click Save or Save and Exitexit to apply the changes.
Tip |
---|
You can also create a request model access configuring record from scratch. For thisTo do so, please 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 | N | Specify an access option. |
Available options:
|
Note | ||
---|---|---|
When a user has no access to create a record with a particular model, the following message appears:
To enable access to the request model for this user, they should match the User Criteria set for this model |
Specify the access option. Available options:
. |
Table of Contents | ||||||
---|---|---|---|---|---|---|
|