Catalog

Release 24

User Guide
Nokia is committed to diversity and inclusion. We are continuously reviewing our customer documentation and consulting with standards
bodies to ensure that terminology is inclusive and aligned with the industry. Our future customer documentation will be updated
accordingly.

This document includes Nokia proprietary and confidential information, which may not be distributed
or disclosed to any third parties without the prior written consent of Nokia. This document is intended for use by Nokia's customers
("You"/"Your") in connection with a product purchased or licensed from any company within Nokia Group of Companies. Use this
document as agreed. You agree to notify Nokia of any errors you may find in this document; however, should you elect to use this
document for any purpose(s) for which it is not intended, You understand and warrant that any determinations You may make or actions
You may take will be based upon Your independent judgment and analysis of the content of this document.

Nokia reserves the right to make changes to this document without notice. At all times, the controlling version is the one available on
Nokia's site.

No part of this document may be modified.

NO WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY OF
AVAILABILITY, ACCURACY, RELIABILITY, TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR
PURPOSE, IS MADE IN RELATION TO THE CONTENT OF THIS DOCUMENT. IN NO EVENT WILL NOKIA BE LIABLE FOR ANY
DAMAGES, INCLUDING BUT NOT LIMITED TO SPECIAL, DIRECT, INDIRECT, INCIDENTAL OR CONSEQUENTIAL OR ANY
LOSSES, SUCH AS BUT NOT LIMITED TO LOSS OF PROFIT, REVENUE, BUSINESS INTERRUPTION, BUSINESS OPPORTUNITY
OR DATA THAT MAY ARISE FROM THE USE OF THIS DOCUMENT OR THE INFORMATION IN IT, EVEN IN THE CASE OF ERRORS
IN OR OMISSIONS FROM THIS DOCUMENT OR ITS CONTENT.

Copyright and trademark: Nokia is a registered trademark of Nokia Corporation. Other product names mentioned in this document may
be trademarks of their respective owners.

© 2024 Nokia.

© 2024 Nokia Document Version 1.0

 Catalog ii
Release 24
User Guide

1 About this document 1

1.1 Audience 1

1.2 Terms and concepts 1

2 Introduction 3
2.1 User roles 3

3 Application interface 5
3.1 Menu 6

3.2 Toolbars 7

3.2.1 Session toolbar 7

3.2.2 Item toolbar 7

3.2.3 Search toolbar 8

3.2.4 Extract to XML toolbar 8

3.2.5 View toolbar 8

3.2.6 Item Editor toolbar 9

3.3 User preferences 9

4 Getting started 11
4.1 Configuring local catalogs 11

4.2 Logging in to a local Catalog 12

4.3 Catalog Designer User Interface 13

4.4 Data security 13

5 Working with Catalog Designer 15

5.1 Importing remote Catalogs 15

6 Working with items 16

6.1 Items tab 16

6.1.1 Filters 17

6.1.2 Columns 17

6.1.3 Item states 18

6.2 Item folders 19

6.2.1 Creating a folder 19

6.2.2 Renaming a folder 19

6.2.3 Deleting a folder 20

© 2024 Nokia Document Version 1.0

 Catalog iii
Release 24
User Guide

6.2.4 Moving or copying a folder 20

6.2.5 Moving or copying an item to a folder 20

7 Designing an item 21
7.1 Creating a new item 21

7.1.1 Creating a new product or service 21

7.1.2 Creating a new technical library or technical service 23

7.2 Defining an item 24

7.3 Adding items 24

7.4 Deleting embedded items 25

8 Configuring an item 26
8.1 Properties tab 27

8.1.1 Searching for an item 27

8.2 Transactions 28

8.2.1 Creating a transaction 28

8.2.2 Configuring an undo transaction 29

8.2.3 Renaming a transaction 29

8.2.4 Copying a transaction 29

8.2.5 Deleting a transaction 30

8.2.6 Including items in a transaction 30

8.3 Automatic mapping 32

8.3.1 Manually applying automatic mapping 32

8.3.2 Removing automatic mapping 32

8.3.3 Mapping highlighting 32

8.4 Messages 33

8.4.1 Creating message mappings 34

8.4.2 Deleting message mapping 35

8.4.3 Expanding messages 35

8.4.4 Collapsing messages 36

8.5 Parameters 37

8.5.1 ParameterView tab 38

8.5.2 Parameter types 39

© 2024 Nokia Document Version 1.0

 Catalog iv
Release 24
User Guide

8.5.3 Creating parameter mappings 39

8.5.4 Deleting parameter mappings 40

8.5.5 Parameter mapping wizard 41

8.5.6 Creating new parameters 44

8.5.7 Editing parameters 45

8.6 Capabilities 46

8.6.1 Creating capabilities 46

8.6.2 Promoting a capability 47

8.7 Dependencies 47

8.7.1 Creating dependencies 48

8.7.2 Resolving dependencies 48

8.7.3 Promoting dependencies 49

8.8 Exclusions 50

8.8.1 Creating exclusions 50

8.8.2 Resolving conflicting exclusions 51

8.9 Activity properties 52

8.9.1 Editing activity properties on Catalog item 53

8.9.2 Editing duration on check in remote item 53

8.9.3 Editing duration on non-fixed local item 54

8.9.4 Editing duration on fixed local item 54

8.9.5 Editing duration on embedded items 55

9 Designing a selection group 56

9.1 Creating a selection group 56

9.2 Defining a selection group 57

9.3 Adding items 58

9.4 Deleting embedded items 59

9.5 Capabilities 59

9.5.1 Creating capabilities 59

9.5.2 Promoting a capability 59

9.6 Dependencies 60

9.6.1 Creating dependencies 60

© 2024 Nokia Document Version 1.0

 Catalog v
Release 24
User Guide

9.6.2 Promoting dependencies 61

9.7 Exclusions 61

9.7.1 Creating exclusions 61

10 Configuring a selection group 63

10.1 Transactions 63

10.1.1 Creating transactions 63

10.1.2 Configuring an undo transaction 63

10.1.3 Renaming a transaction 64

10.1.4 Copying a transaction 64

10.1.5 Deleting a transaction 64

10.1.6 Selecting embedded item transaction 65

10.2 Parameters 65

10.2.1 Creating parameter mappings 66

10.2.2 Deleting parameter mappings 66

10.2.3 Creating new parameters 66

10.2.4 Editing parameters 69

10.3 Rules 69

10.3.1 Defining a rule 70

10.4 Activity properties 72

10.4.1 Editing duration auto sum type on check in selection group item 73

10.4.2 Editing duration on embedded items 74

11 Extracting items to XML 75

12 Interacting with Business Service Tool 76

12.1 Configuring remote item groups 76

12.2 Processing order 76

13 Catalog lifecycle for products and services 78

13.1 Catalog lifecycle 78

13.2 Publishing items 79

13.3 Version control 79

13.3.1 Creating a new version 80

13.4 Copying items 80

© 2024 Nokia Document Version 1.0

 Catalog vi
Release 24
User Guide

13.5 Replacing embedded items/selection groups 81

13.5.1 Using item editor tab 81

13.5.2 Using items tab of the trees and lists area 82

13.6 Comparing items 82

13.7 Check in items 83

13.7.1 Check in items in folder 83

13.7.2 Check in Where Used items 84

13.8 Update transition on items 84

13.8.1 Updating transition of items in folder 84

13.8.2 Updating transition Where Used items 85

14 Troubleshooting 87

© 2024 Nokia Document Version 1.0

 Catalog 1
Release 24
User Guide

1 About this document

This document provides information on how to use Catalog Designer UI and the
configuration procedures that must be performed before using it.

1.1 Audience
This document is intended for persons who need to use the Catalog Designer to create
and maintain products, services and technical service definitions in Catalog. It is
assumed that the reader is familiar with Catalog.

In the Catalog model the Item Types of product, service, technical library and
technical service have no technical or functional importance and are used in this
document for illustrative purposes only. They default to these four values in Catalog
Operational Client but can be changed to be specific to your organisation. For more
information on Item Types, refer Catalog Operational Client User Guide.

1.2 Terms and concepts

The following abbreviations, terms and concepts are used in the document.

Application Programming A language and message format used by an application program to

Interface, API communicate with a program that provides services for it. API can
also be used to access other services, for example, a communications
protocol, or control programs, such as a database management
system (DBMS).
Asymmetric Digital A type of digital subscriber line (DSL) technology, a data
Subscriber Line, ADSL communications technology that enables faster data transmission
over copper telephone lines rather than a conventional voiceband
modem can provide.
Business Service Tool A component of Provisioning and Activation and Order Management
that enables design and execution of provisioning logics and order
management.
Catalog A component of the FlowOne Fulfillment suite that allows managing
service lifecycle and provides a centralised view of a deliverable
product portfolio. It combines the commercial and technical views of
the offerings, and decomposes the delivery items into reusable
elements.
Catalog Database Includes all the necessary schemata and schema objects required to
support the proprietary Catalog data.
Catalog Designer UI A client application installed on a workstation that interacts with
Catalog database. The UI allows creating and maintaining products,
services and technical services. It is also used for administrative
tasks, such as managing user accounts.
Catalog Operational Client Web-based client that allows you to perform Catalog administrative
tasks. These tasks include exporting and importing data, creating and
modifying Catalog users, changing passwords and modifying system
parameters.

© 2024 Nokia Document Version 1.0

 Catalog 2
Release 24
User Guide

dependency A sanity check rule that helps managing product structures. Can
state, that a customer who wants a monthly spending limit must also
have a contract based mobile subscription.
exclusion A sanity check rule that helps managing product structures. Can
state, for example, that a product that includes a 4 MB DSL line
cannot simultaneously include a 2 MB DSL line.
item Catalog allows user to create and maintain product, service or
resource definitions as generic items. Items can be explicitly defined
as products, services or any user defined term, or they can be left as
generic items. Products and Services are defined by encapsulating
and combining these items.
product A CRM or other BSS system level product that defines a sellable and
marketable, business driven commercial offering.
service A group of technical services that can be sold to a customer as part of
a product.
state A product's phase in its life-cycle. When a product traverses from
development to testing and finally into a commercial product, its
state changes accordingly from Working to Testing and Published.
Catalog has a predefined state model which determines the state
transitions.
technical library A collection of technical services and provisioning logic formatted
for the BST Interface for Catalog.
technical service A specification of a network level capability with attributes that
define a network driven service.
User Interface, UI The interface features through which users interact with the hardware
and software of computers and other electronic devices.

© 2024 Nokia Document Version 1.0

 Catalog 3
Release 24
User Guide

2 Introduction
Catalog Designer is a client application installed on your PC that interacts with your
Catalog database and any remote catalogs within your organisation. Catalog Designer
is where you create and maintain new products and services.

2.1 User roles

Catalog Designer supports four predefined types of user called roles. Additional user
roles could be available within your organisation, depending on your Catalog
implementation. Your user account is allocated to one or more user roles, and the
functionality available to you is determined by the roles to which you are assigned.

The predefined user roles are:

Administrator – a user who has full access to Catalog Designer and in addition has
the ability to force the check in of items checked out to other users.

Developer – a user who has full access to Catalog Designer and can force the check in
of items to be checked out to other users. This role has the same privileges as the
existing role namely Administrator. In addition, this role is given the right to modify
embedded item. For more information about the Developer user role, see Catalog
Developer Mode User Guide.

Product Manager – a user who is able to create products and services but is not able
to specify the interaction of the embedded items as they may not have a technical
understanding of the services and resources being utilised. The Product Manager has
access to the following views:
• Items view
• Capabilities view
• Properties view
• Search view

The Product Manager can:

• create, delete and move folders
• create, edit, delete and move items/pseudo remote items/selection groups
• transition item through the item lifestyle

The Product Manager has access to the design tab of the item and selection group
editors, and can perform the following actions:
• add and remove embedded items
• maintain item/selection group capabilities, dependencies and exclusions
• maintain item/selection group parameters.

© 2024 Nokia Document Version 1.0

 Catalog 4
Release 24
User Guide

Service Engineer – a user who has full access to Catalog Designer. The Service
Engineer is able to import resources and services from remote systems, and create
complete products, services and selection groups including the interaction of the
embedded items. It is expected that Service Engineers have a full technical
understanding of the products, services and resources within Catalog.

In addition, there are User defined roles – a user with a user defined role does not
have access to the Designer UI, beyond the ability to login. The UI is presented as
inaccessible to them. Current functionality on this type of role is limited to the
Signoff functionality on Transitions, which can be found under the Items tab in the
Catalog Operational Client.

© 2024 Nokia Document Version 1.0

 Catalog 5
Release 24
User Guide

3 Application interface
The main window of Catalog Designer user interface (UI) is divided into four areas,
as shown in Figure 1.

Figure 1. Main window of the Catalog Designer

The four areas that comprise the main window, and the tabs that each area can
contain, are:
• The Trees and Lists area always includes the following tabs:
º The Items tab displays every item and selection group available to you in a
hierarchical tree structure.
º The Capabilities tab displays items and selection groups by their capabilities.
º The ParameterView tab displays the set of parameters used when creating
items.
º The Remote Item Groups tab allows defining which technical services can
be processed together in the network.
• Design and Configuration area is populated by tabs that are opened when the
appropriate entity/action is selected elsewhere in the Catalog Designer UI. The
actual tab names pertain to the entity selected, but they can be distinguished as
follows:
º Item Editor and Selection Group Editor tabs have a Design area and one or
more Transaction areas.
a) The Design area provides a workspace for product managers to select
and assemble the building blocks of new products and services.

© 2024 Nokia Document Version 1.0

 Catalog 6
Release 24
User Guide

b) The Transaction area is a workspace where engineers can implement

the product manager's vision in terms of transactions. You can have
many configuration areas displayed, each representing individual
transactions that are an operation that can be performed on an item.
Each configuration area tab is labelled with the name of the
transaction it represents.

º The Remote Catalog tab displays information about a remote catalog. It is

displayed by double-clicking on a remote catalog name in the Catalogs area.
º The Remote Items Group Editor tab is reserved for future use.
º The Operational Client tab opens the Catalog Operational Client. For more
information, refer Catalog Operational Client User Guide.
• The Catalogs area always displays one tab:
º The Catalogs tab displays remote catalogs that you can use.
• The Properties and Search area always includes the following tabs:
º The Properties tab displays the properties of any item/selection group
selected in another tab. Depending on configuration you can edit some or all
of the properties for each item or selection group.
º The Search tab is used to find items and selection groups by name and/or
capability.
You can work with the information in these panes to create, design and publish your
new products and services. A pop-up menu that enables you to configure the layout of
interface can be accessed by right-clicking anywhere on the grey background area of
each pane to open the layout pop-up menu. Alternatively, you can expand or collapse
any pane using the maximise and minimise buttons, and change the location
of the different tabs using drag and drop to move them to different areas on the
interface.

The tab layout used throughout this document is the default layout for Catalog.

3.1 Menu
The Catalog UI’s menu bar contains the menus and items detailed in Table 1.

Table 1. Catalog menu items

Menu Item Description Keyboard shortcut
File Login to Catalog Connects to your local Catalog.
Logout of Catalog Disconnects from your local Catalog.
Change Password Enables a user to change their
password.
New Item Creates a new item.
New Remote Item Creates a new technical service.
New Selection Group Creates a new selection group.
Save Saves a Catalog item. CTRL+S
Save All Saves all modified editors. CTRL+SHIFT+S

© 2024 Nokia Document Version 1.0

 Catalog 7
Release 24
User Guide

Table 1. Catalog menu items

Menu Item Description Keyboard shortcut
Exit Exits the Catalog Designer.
View Items Displays the Items tab.
Capabilities Display the Capability Matrix tab.
Parameters Display the Parameters tab.
Catalogs Displays the Catalogs tab.
Remote Item Groups Displays the Remote Item Groups
tab.
Properties Displays the Properties tab.
Operational Client Displays the Operational Client tab.
Extract Extract to XML Extracts one or more Catalog items to
an XML file.
Search Search Items/Capabilities Displays the Search tab.
Window Preferences Displays the Preferences dialog box,
allowing users to configure how the
Catalog Designer works. For more
information, see Section 3.3 User
preferences.)
Reset Perspective... Resets the UI back to the default
layout.
Help About Catalog Displays the About dialog.

3.2 Toolbars

3.2.1 Session toolbar

The Session toolbar comprises the items detailed in Table 2.

Table 2. Buttons in the Session toolbar

Icon Name Description Keyboard shortcut
Login to Catalog Logs you in to Catalog.

Logout of Catalog Logs you out of Catalog.

Change Password Changes your password.

3.2.2 Item toolbar

The Item toolbar comprises the items detailed in Table 3.

Table 3. Buttons in the Item toolbar

Icon Name Description Keyboard shortcut
New Item Creates a new product or service.

New Remote Item Creates a new technical service.

© 2024 Nokia Document Version 1.0

 Catalog 8
Release 24
User Guide

Table 3. Buttons in the Item toolbar

Icon Name Description Keyboard shortcut
New Selection Group Creates a new selection group.

Save Saves a Catalog item. CTRL+-S

Save All Saves all modified editors. CTRL+SHIFT+S

3.2.3 Search toolbar

The Search toolbar comprises the items detailed in Table 4.

Table 4. Buttons in the Search toolbar

Icon Name Description Keyboard shortcut
Search Items/Capabilities Displays the Search tab.

3.2.4 Extract to XML toolbar

The Extract to XML toolbar comprises the items detailed in Table 5.

Table 5. Buttons in the Extract to XML toolbar

Icon Name Description Keyboard shortcut
Extract to XML Extracts one or more Catalog items to
an XML file.

3.2.5 View toolbar

The View toolbar comprises the items detailed in Table 6.

Table 6. Buttons in the View toolbar

Icon Name Description Keyboard shortcut
View Items Displays the Items tab.

View Capabilities Displays the Capabilities Matrix tab.

View Parameters Displays the Parameters tab.

View Catalogs Displays the Remote Catalogs tab.

View Remote Item Groups reserved for future use

View Properties Displays the Properties tab.

View Operational Client Displays the Operational Client tab.

© 2024 Nokia Document Version 1.0

 Catalog 9
Release 24
User Guide

3.2.6 Item Editor toolbar

The Item Editor toolbar comprises the items detailed in Table 4.

Table 7. Buttons in the Item Editor toolbar

Icon Name Description Keyboard shortcut
Undo Undoes the previous action.

Redo Redoes the previous action.

Delete Deletes the current selection.

New Capability Creates a new capability.

New Dependency Creates a new dependency.

New Exclusion Creates a new exclusion.

New Transaction Creates a new transaction.

Edit Transaction Displays the Edit Transaction dialog

box.
Copy Transaction Creates a new transaction as a copy of
an existing transaction.
Delete Transaction Deletes the current transaction.

New Parameter Creates a new parameter.

Edit Parameter Displays the Edit Parameter dialog

box.
Collapse All Messages Collapses the messages on the current
transaction.
Expand All Messages Expands the messages on the current
transaction.
Show/Hide Parameter Toggle button to show/hide the
Mappings parameter mappings.
Show/Hide Message Toggle button to show/hide the message
Dependencies dependencies
Highlight Mode On/Off Toggle button to turn on/off the
selection highlighting
Zoom Drop-down list containing zoom levels

3.3 User preferences

The Preferences dialog box allows you to change aspects of the Catalog UI’s
appearance.

© 2024 Nokia Document Version 1.0

 Catalog 10
Release 24
User Guide

To access the Preferences dialog box, select Window > Preferences.

The options that can be changed are detailed in Table 8.

Table 8. Options that can be set in the Properties dialog box

Page Preference Description
Colours Highlight Colour The colour used to highlight in the Transaction area on the
Item Editor tab when highlight mode is turned on.
Selected Colour The colour used to display the selection in the Transaction
area on the Item Editor tab.
Message Dependency Colour The colour used to display message mappings in the
Transaction area on the Item Editor tab when highlight
mode is turned off.
Parameter Mapping Colour The colour used to display parameter mappings in the
Transaction area on the Item Editor tab when highlight
mode is turned off.
General Automatically map When enabled, automatic mapping is attempted when an
transactions, messages and item is embedded.
parameters when embedding The options for automatic parameter mapping behaviour if
an item a parameter has default values defined are:
• Always – always map parameters which have default
values.
• Never – never map parameters that have default
values.
• Prompt – prompt for which parameters with default
values should be mapped.
When displaying an item When enabled, opening the Item Editor tab will display all
initially show all messages in messages in the collapsed state.
the collapsed state When disabled, opening the Item Editor tab will display
all messages in the expanded state.
Automatically promote When enabled, capabilities in items being embedded are
capabilities when embedding automatically promoted to the parent item if they are not
an item already present.
Automatically promote When enabled, dependencies in items being embedded are
dependencies when automatically promoted to the parent item if they are not
embedding an item. already present.
Value to display for the name The options for the field to use for the name of an item:
of an item. • Name - display the name of the item.
• Alias - display the alias of the item. If an alias has not
been defined, the name of the item is displayed.

© 2024 Nokia Document Version 1.0

 Catalog 11
Release 24
User Guide

4 Getting started
This chapter gives instructions on how to configure local catalogs, log in to Catalog
Designer, and how to work with the Catalog Designer UI.

4.1 Configuring local catalogs

When you first open Catalog Designer, you are presented with the Catalog splash
screen. You need to configure the connection details for your local catalog. Your local
catalog connection details are specific to your organisation. Your Catalog
administrator is able to provide you with the details for your implementation.

To configure your connection details

1. Click the Define button on the Catalog Login dialog box.

The Catalog Connections screen is displayed.

2. Click Add to add a new local catalog.

3. In the Name field enter the name of your local catalog.

4. In the Host field enter the server name or IP address of the server where your
local catalog is installed.

5. In the Port field list the port number that your local catalog uses for
communication.

6. If the port is used for secure communication via HTTPS, check the Secure
Transport check box.

7. Click Apply.

Your local catalog name is displayed in the Catalogs list.

To set up Java explicitly

By default, the Catalog designer picks a JDK workstation, which is configured as

JAVA_HOME in the system environment. It is also possible to explicitly set the JDK
path in the designer.ini file if there are multiple JDKs configured on a
workstation.

1. Open designer.ini file.

© 2024 Nokia Document Version 1.0

 Catalog 12
Release 24
User Guide

2. Mention the jdk path.

Example:

-vm

C:\ProgramFiles\openlogic-openjdk-8u292-b10-windows-64\b
in

-startup

<...>

3. Save the file.

You can configure multiple local catalogs by repeating this process. When you have
configured all the catalogs you require, click OK to return to the login screen.

To test the availability of the selected catalog, click the Test Connection button. This
will verify if the host and port can be reached.

Note The Test Connection button only verifies if the host and port are reachable, it
does not verify if the catalog has been configured at that location.

4.2 Logging in to a local Catalog

When you open Catalog Designer, you are presented with the Catalog splash screen.
To log in, select File > Login to Catalog from the menu or click the Login button.
The Catalog login page is displayed. If you have more than one local catalog
configured, select the catalog you require from the Catalog drop-down list and enter
your username and password in the Username and Password fields. The default
settings of these values are given in Table 9.

Table 9. Default values for the fields in the Login dialog box
Field Default value
Username admin
Password password123!

If the login dialog box is closed, or if you want to log in to a different catalog instance
while you are currently logged in, you should select File > Login to Catalog from the
menu or click the Login button .

© 2024 Nokia Document Version 1.0

 Catalog 13
Release 24
User Guide

4.3 Catalog Designer User Interface

Once you have logged in to your local catalog, you are prompted to confirm that you
are authorised to access the Catalog system. Click Yes to confirm that you have the
appropriate authorisation. The Catalog Designer UI opens, and resembles the
example shown in Figure 2.

Figure 2. Example view of Catalog Designer after login

You can now begin to create new products and services or adapt existing ones. Each
of these is termed an item within Catalog. You can use any of the fixed items in your
local catalog or items imported from remote catalogs to create your own items in the
Design and Configuration area.

4.4 Data security

Access to items within Catalog Designer can be restricted based upon the roles and
User Groups that the current user is assigned to.
The level of access based upon roles is as follows:
• If the most lenient access for an item type is defined as None against the role(s)
the user is associated with, items of that type are not visible within Catalog
Designer.
• If the most lenient access for an item type is defined as Read-only against the
role(s) the user is associated with, items of that type can be viewed and can be
embedded within other items/selection groups but cannot be created or edited
within Catalog Designer.

The level of access based upon User Groups is as follows:

• If an item does not exist in any User Groups that the user belongs to, that item is
not visible within Catalog Designer.

© 2024 Nokia Document Version 1.0

 Catalog 14
Release 24
User Guide

• If the most lenient access for an item in any of the User Groups that the user
belongs to is read-only, the item can be viewed and can be embedded within other
items/selection groups but cannot be edited within Catalog Designer.

When both role/item type and User Group data security are combined then the most
restrictive access is applied, as described in Table 10.

Table 10. Role/Item Type access combined with User Groups

Role or Item Type
Full Read-only None
User Group Full Full Read-Only None
Read Only Read-Only Read-Only None
For more information, refer Catalog Operational Client User Guide.

© 2024 Nokia Document Version 1.0

 Catalog 15
Release 24
User Guide

5 Working with Catalog Designer

Catalog Designer enables you to work with items held in different catalogs to create
new products and services. Catalog works with two types of catalog:
• Local – the catalog you are logged in to.
• Remote – remote Catalog that conforms to the Catalog assembly standard.

These catalogs are specific to your organisation. Contact your local system
administrator for information on the catalogs that are available for your use.

5.1 Importing remote Catalogs

You must connect and import any remote catalogs before you can work with their
contents. You can connect to any remote catalog or system that conforms to the
Catalog API. You can import any remote item in a remote catalog to your Catalog
environment.

To connect to and import a remote catalog

1. On the Catalogs tab of the Catalogs area, either:

• right-click in the area beneath the Catalogs tab and select New Catalog
from the pop-up menu, or
• click the New Catalog button .
The New Catalog Details dialog box is displayed.

2. Enter the Catalog URL for your remote catalog. The format of the Catalog
URL is http://host:port/Catalog/services.

3. Click OK.

Your remote catalog is now included on the Catalogs tab.

4. On the Catalogs tab, choose whether to import individual items (you can
expand any remote catalog using the expand icon ) or a complete catalog
by selecting the appropriate check box that is next to the catalog name.

5. Right-click on the catalog name in the Catalogs tab and choose Import
<Name> Catalog from the pop-up menu.

Your chosen remote items are added to the Items tab of the Trees and Lists
area and are available for inclusion in any products or services you design.

Once you have connected to remote catalogs and imported any items that you require,
these are available to you from the Items tab of the Trees and Lists area. Items that
are listed on the Items tab can be moved or copied to one or more folders.

© 2024 Nokia Document Version 1.0

 Catalog 16
Release 24
User Guide

6 Working with items

An item can represent a product, service or technical service. You use existing items -
products, services and technical services - as the building blocks for creating new
items.

Remote items are technical services and cannot contain other items; instead, they can
be combined with other items to create a new item representing a product or service.
These must adhere to rules that control the validity of the constituent items (for
example, what inputs each item requires to function and what it is unable to work
alongside) as well as define the operations that the item can perform (for example,
provide, amend and cease) and the interaction of the constituent items that make up
that operation (for example, the orchestration of messages and data).

6.1 Items tab

The Items tab in the Trees and Lists area displays every item available to you in a
hierarchical tree structure. An example of this is shown in Figure 3.

Figure 3. Example of the Items tab

© 2024 Nokia Document Version 1.0

 Catalog 17
Release 24
User Guide

As can be seen from Figure 3, the Items tab has a set of filters at the top. The
remainder of the tab comprises a hierarchical tree structure of items with columns of
information about each of the items. This section explains the terms and icons used on
the Items tab.

6.1.1 Filters
You can apply a filter to reduce the volume of items displayed so that they are more
relevant to the work that you are doing. The filters that can be applied are explained in
Table 11.

Filters can be combined, meaning that you can apply one of each type simultaneously.

Table 11. Filters that can be applied to the items on the Items tab
Filter Description
Type If item types have been defined in the system, then when an item is created a type can be
assigned to it. This field contains a drop-down list of items and can be used to filter the
view to only show items with the selected type.
Latest Select this check box to filter the view to only show items with the highest version number
for each item name.
Name This field can filter items based upon their name. Wildcards * and ? can be used to
represent multiple characters and a single character respectively. The filter is case
insensitive.

6.1.2 Columns
The columns of information given for each item are explained in Table 12.

With the exception of the first column (Item), you can reorder the columns by using
drag and drop in the column titles.

Table 12. Columns of information applicable to items on the Items tab

Name Description
Item Displays the folder structure and the item's name and version. Items can be
expanded to display the nested items in the hierarchy. The state of each item is
shown by an icon before the item’s name. For more information on item states, see
Section 6.1.3 Item states.
Status Displays the item's lifecycle state, for example, Working, Testing or Published. For
more information on lifecycle states, see Section 13.1 Catalog lifecycle.
Type Displays the item's type.
Checkout User Displays the user ID of the user to whom the item is checked out.
External Id Displays the external ID of the item. This ID can be used by the SOAP API to
reference an item.
Locked Displays the user ID of the user to whom the item is locked.

© 2024 Nokia Document Version 1.0

 Catalog 18
Release 24
User Guide

6.1.3 Item states

Items can be in one of several states. Different icons are used in the Items tab and on
the Item Editor tab to indicate the current state of an item. The icons and the state
that each represents are detailed in Table 13.

Table 13. Item states

Icon Description
A remote item.

A remote item that is checked out to your user ID.

A remote item that is checked in or checked out to another user ID.

A valid selection group that is checked out to your user ID.

An invalid selection group that is checked out to your user ID. The reason(s) why it is invalid
are displayed in the Errors section of the Properties tab in the Properties and Search area.

A valid selection group that is either checked in or checked out to another user ID.

An invalid selection group that is either checked in or checked out to another user ID. The
reason(s) why it is invalid are displayed in the Errors section of the Properties tab in the
Properties and Search area.
A valid local item that is checked out to your user ID.

An invalid local item that is checked out to your user ID. The reason(s) why it is invalid are
displayed in the Errors section of the Properties tab in the Properties and Search area.
A valid local item that is either checked in or checked out to another user ID.

An invalid local item that is either checked in or checked out to another user ID. The
reason(s) why it is invalid are displayed in the Errors section of the Properties tab in the
Properties and Search area.
A fixed item.

A fixed item with allowed instances.

A fixed, published item with allowed instances.

Fixed items

Once an item is complete, you can change its state by starting a transition. Depending
on the Catalog lifecycle defined, some state changes cause the item to become fixed.

© 2024 Nokia Document Version 1.0

 Catalog 19
Release 24
User Guide

Fixed items are items that are available to other users. They can be used as
components in other items; consequently, an item should not be moved to a state
where it is fixed until its design and configuration is complete and all dependencies
have been resolved.

In the default Catalog lifecycle, an item becomes fixed when it moves to a state of
Published or Testing (see Section 13.1 Catalog lifecycle).

6.2 Item folders

Each folder in the hierarchical tree structure can contain items and other folders.
Folders can be manipulated (created, moved and copied) to logically group items to
suit your needs. The same item, both local and remote, can exist in multiple folders.

New items are automatically created in the folder that is selected when that item is
created. Remote items are imported into a folder with the same name as the remote
catalog under the Remote Items folder.

6.2.1 Creating a folder

To create a new folder

1. In the hierarchical tree structure, right-click on the folder under which you
want to create a new folder and select New Folder from the pop-up menu.

The New Folder Wizard is displayed.

2. Enter a name for the new folder in the Name field.

3. Optionally, change the parent folder by navigating to a folder in the Create in

field. By default, this is set to the folder that you selected in step 1.

4. Click Finish.

Your new folder is created and appears in the hierarchical tree structure under
the specified folder.

6.2.2 Renaming a folder

To rename a folder

1. In the hierarchical tree structure, right-click on the folder that you want to
rename and select Rename Folder from the pop-up menu.

The Rename Folder dialog box is displayed.

2. Enter the new name for the folder in the Folder name field.

3. Click Finish.

© 2024 Nokia Document Version 1.0

 Catalog 20
Release 24
User Guide

The name of the specified folder is updated in the hierarchical tree structure.

6.2.3 Deleting a folder

To delete a folder

1. In the hierarchical tree structure, right-click on the folder that you want to
delete and select Delete Folder from the pop-up menu.

The folder is removed from the hierarchical tree structure.

Note You can only delete empty folders.

6.2.4 Moving or copying a folder

You can drag and drop a folder from its current location to a new parent.

To copy a folder under a new parent, hold down the CTRL key while dragging and
dropping.

6.2.5 Moving or copying an item to a folder

You can drag and drop an item from its current location to a new folder.

To copy an item under a new folder, hold down the CTRL key while dragging and
dropping.

© 2024 Nokia Document Version 1.0

 Catalog 21
Release 24
User Guide

7 Designing an item
In Catalog Designer, you use existing local and remote items as the building blocks
for creating new items. When you start to create a new item, it is displayed in the
Items tab of the Trees and Lists area and is visible to other local users but cannot be
used or changed by them. Remote items cannot be modified; instead, they can be
combined with other local and remote items to create a new item representing a
product or service.

You can design new items (products, services and other components) by arranging
existing items from your local and remote catalogs together in the Item Editor tab of
the Design and Configuration area using drag and drop. You can modify any items
that are checked out to your user ID.

Any items that you design are held in your local catalog and are not externally visible
until they are published. This means that you can design and test your items before
they are made available through publication.

The Item Editor includes an icon which displays the item’s state. Item states are
detailed in Section 6.1.3 Item states.

7.1 Creating a new item

Before creating a new item, the type of item must be decided. There are four possible
item types:
• product – a CRM or other BSS system level product that defines a sellable and
marketable, business driven commercial offering. For information on creating a
new product, see Section 7.1.1 Creating a new product or service.
• service – a group of technical services that can be sold to a customer as part of a
product. For information on creating a new service, see Section 7.1.1 Creating a
new product or service.
• technical library – a collection of technical services and provisioning logic
formatted for the BST Interface for Catalog. For information on creating a new
technical library, see Section 7.1.2 Creating a new technical library or technical
service.
• technical service – a specification of a network level capability with attributes that
define a network driven service. For information on creating a new technical
service, see Section 7.1.2 Creating a new technical library or technical service.

7.1.1 Creating a new product or service

To create a new product or a service

1. Do one of the following:

• select File > New Item, or

• click the New Item button .

© 2024 Nokia Document Version 1.0

 Catalog 22
Release 24
User Guide

The New Item Wizard is displayed.

2. Enter a name for your item in the Name field.

Item name must be unique. It is not possible to use a name for a product that is
already used by a service or a technical service.

3. Enter a unique value (integer) in the External ID field. The External ID is

optional; if you do not enter a value, Catalog creates a random value for the
External ID.

If you enter a value which is already in use, you see the following error
message: Failed to create item. External id [2062] already
exists.

4. Select Product or Service from the Type list.

5. Optionally enter an alias in the Alias field. For more information, see Section
3.3 User preferences.

6. Select which transactions you would like to create for your item. All available
transactions will be selected by default. Use the CTRL key to select multiple
transactions. At least one transaction must be selected.

7. Navigate to the item group under which the new item should be added in the
Create in field.

8. If displayed, select the User Groups that the item should be assigned to.
These are the User Groups that the current user has full access to.

The master User Group is never displayed as all items are added to the master
User Group.

9. Optionally, enter a Description.

10. Click Finish.

Your new item is created locally and appears under the specified directory on
the Items tab of the Trees and Lists area with a Status of Working. A new
Item Editor tab representing the new item is opened in the Design and
Configuration area. The Item Editor tab will have a Design sub-tab and one
or more Transaction sub-tabs. The default transactions for a new item are
defined in the Catalog system parameters. For more information on the
Catalog system parameters, refer Catalog Operational Client User Guide.

© 2024 Nokia Document Version 1.0

 Catalog 23
Release 24
User Guide

By default, when you create a new item it is checked out to your user ID. You
can identify which items are checked out to which users in the Checkout
User column of the Items tab. You cannot edit items that are checked in or
checked out to other users. Check-out information for each item is also
displayed in the Properties tab of the Properties and Search area.

7.1.2 Creating a new technical library or technical service

To create a new technical library or technical service

1. Do one of the following:

a) select File > New Remote Item, or

b) click the New Remote Item button .

The New Item Wizard is displayed.

2. Enter a name for your item in the Name field.

3. Enter a unique value (integer) in the External ID field.

The External ID is optional; if you do not enter a value, Catalog creates a

random value for the External ID.

If you enter a value which is already in use, you see the following error
message: Failed to create item. External id [2062] already
exists.

4. Optionally enter an alias in the Alias field. For more information, see Section
3.3 User preferences.

5. Select Technical Library or Technical Service from the Type list.

6. Select which transactions you would like to create for your item. All available
transactions will be selected by default. Use the CTRL key to select multiple
transactions. At least one transaction must be selected.

7. In the Create in field navigate to the folder under which the new technical
library or technical service should be added.

8. If displayed, select the User Groups that the item should be assigned to.
These are the User Groups that the current user has full access to.

The master User Group is never displayed as all items are added to the
master User Group.

9. Optionally, enter a Description for the technical library or technical service.

© 2024 Nokia Document Version 1.0

 Catalog 24
Release 24
User Guide

10. Click Finish.

Your new technical library or technical service is created with version number
1.0 and appears under the specified directory on the Items tab of the Trees,
and Lists area. The status of the technical library or service is checked out,
which allows configuring capabilities and parameters for the technical library
or service.

7.2 Defining an item

After you have created an item, you need to complete its definition. This is done in
the Item Editor tab of the Design and Configuration area.

You can enlarge the Item Editor tab to full screen size by using its the maximise
button . Alternatively, you can enlarge the lower section of the Item Editor tab’s
Design sub-tab by placing the mouse cursor within it and holding down the CTRL
key while rotating the scroll wheel on the mouse.

To define a new item

1. Double-click on the new item in the Items tab of the Trees and Lists area.

The Item Editor tab for that item is opened in the Design and Configuration
area.

2. Drag and drop the relevant items from the Items tab into the lower section of
the Item Editor tab’s Design sub-tab.

3. After you have added the items that you require, you must identify and resolve
or promote any outstanding dependencies. For more information on how to do
this, see Section 8.7 Dependencies).

4. Click the Save button to save your newly-designed item,

5. To check in your saved item, right-click on the item in the Items tab and select
Check In from the pop-up menu.

An item automatically saves when a change is made to its embedded items.

7.3 Adding items

When embedding one or more items into an item or selection group, the capabilities
and dependencies of those items will be automatically promoted to the parent item
according to preferences settings, see Section 3.3 User preferences.

© 2024 Nokia Document Version 1.0

 Catalog 25
Release 24
User Guide

Dependencies in the embedded items that have corresponding capabilities either in

the capabilities being promoted or in the parent item will not be promoted. If a
capability is promoted which has a corresponding dependency in the parent item, the
dependency will be removed from the parent item.

7.4 Deleting embedded items

When deleting one or more embedded items, Catalog Designer will examine their
capabilities and dependencies. If any are present in the parent item they will be
displayed in a dialog. You can choose which of the capabilities and dependencies to
remove from the parent item along with the embedded items.

Select multiple capabilities and dependencies using the CTRL button, or press
Select All or Deselect All to select all or none of them. Press OK to close the dialog
box after making your selection.

© 2024 Nokia Document Version 1.0

 Catalog 26
Release 24
User Guide

8 Configuring an item
Once your item has been defined, see Section 7.2 Defining an item. The details of its
implementation – the transaction(s) that can be performed on the item – must be
configured, checked and validated before that item can be published. You can
configure these activities in the Transaction sub-tab of the Item Editor tab, an
example of which is shown in Figure 4.

Figure 4. Example of the Amend transaction sub-tab

The default message types within a transaction, as shown in the Transaction bar, are:
• Request: The initial message to start the transaction and pass in any required
parameters.
• Response: The asynchronous response to acknowledge the request and to
complete the identification of the transaction on both systems.
• Complete: The notification of completion, whether successful or not), the
transaction and the passing out of any return parameters.

Note In Catalog, the request message on the product or service contains the
parameters that are returned to the client requesting the specification or
decomposition of the product or service.

You can enlarge the Item Editor tab to full screen size by using the maximise
button . Alternatively, you can enlarge the lower section of the Item
Editor tab’s Transaction sub-tab by placing the mouse cursor within it and
holding down the CTRL key while rotating the scroll wheel on the mouse.

© 2024 Nokia Document Version 1.0

 Catalog 27
Release 24
User Guide

8.1 Properties tab

When configuring an item, the Properties tab in the Properties and Search area
provides useful information about that item and is also required for certain
configuration tasks. The sections included on this tab are dependent on the item
selected – the possible sections are explained in Table 14.

Table 14. Possible sections in the Properties tab

Section Description
Conflicting Exclusions Displays the conflicting exclusions of the selected item and the items
with which it is in conflict.
Description Displays a description of the current selection.
Additional information can also be displayed, depending on the current
selection:
• If the current selection is an item, the external ID is displayed.
• If the current selection is an item that is checked out, the checkout
details are displayed.
• If the current selection is an embedded item, selection group,
message or parameter, the parameter connections are displayed.
Details If an item is selected, this displays the capabilities, dependencies and
exclusions of the selected item.
Embedded Items Only displayed when a selection group is selected. The content depends
on which sub-tab in the Item Editor tab a selection group is selected:
• If selected from the Design sub-tab, this displays the items within
the selection group and allows you to sequence them.
• If selected from a Transaction sub-tab, this displays the rules for
the items within the selection group and allows you to maintain
those rules.
Errors Displays a list of issues that you need to resolve before the item can
become valid.
Information A tree table displaying the description (name), details (value) and,
optionally, units of the item. These can be nested, as item information
can contain other item information. This structure is included in the PSA
discover response for an item.
Lifecycle Displays the lifecycle transitions for the selected item. Transitions that
have not started or have started but not finished can be deleted (by
right-clicking on them and selecting Delete from the pop-up menu).
Outstanding Dependencies Displays any outstanding dependencies and possible item candidates to
resolve those dependencies.
Parameters Displays the parameters of the selected message. Parameters are
grouped by namespace. Mandatory parameters are highlighted in bold.
Transactions Displays the defined transaction, with its associated undo transaction
and cancel transaction.
Where Used Displays where the selected item has been used, either embedded
directly or within a selection group.

8.1.1 Searching for an item

You can search your local and remote catalogs in one of the following ways:
• select Search > Search Items/Capabilities

© 2024 Nokia Document Version 1.0

 Catalog 28
Release 24
User Guide

• click the Search button

This opens the Search tab in the Properties and Search area. Alternatively, you can
navigate to this tab directly. Enter your search term in the search field and click
Search to obtain a listing of all items and capabilities that contain that term.

If the result is a capability, you can double-click on it to highlight that capability in

the Capabilities tab. Alternatively, you can drag and drop the capability into the
Capabilities, Dependencies or Exclusions area of an Item Editor tab’s Design
sub-tab.

If the result is an item or selection group, you can double-click on it to open that item
or selection group in an Item Editor or Selection Group Editor tab. Alternatively,
you can drag and drop the item into the Design sub-tab of an Item Editor or
Selection Group Editor tab pertaining to a different item or selection group.

8.2 Transactions
Transactions define the operations that can be carried out on an item. For example, an
ADSL service might have transactions called Provide and Cease, and an ADSL
Router (modem) might have a transaction called Order.

Default transactions are defined using the Catalog system parameter Default
Transactions and are added when a new item is created. An item must have at least
one transaction defined, but more transactions can be added as appropriate.

Note To make a transaction Business Service Tool compliant, the transaction name
must be Create, Modify, Display or Delete.

8.2.1 Creating a transaction

To create a transaction

1. Do one of the following:

• right-click in the lower section of the Transaction sub-tab and select New
Transaction from the pop-up menu
• click on the New Transaction button .
The New Transaction dialog box is displayed.

2. Enter a name for your new transaction in the Transaction name field.

3. Click Finish.

A new Transaction sub-tab, with the appropriate name is added to the Item
Editor tab.

© 2024 Nokia Document Version 1.0

 Catalog 29
Release 24
User Guide

8.2.2 Configuring an undo transaction

If a transaction fails during processing, Catalog attempts to undo any transactions on
the embedded items that have already completed. Catalog can only do this if another
transaction has been configured as the undo transaction.

To configure an undo transaction

1. Right-click in the lower section of the Transaction sub-tab and select Undo
Transaction from the pop-up menu, then select the transaction that is to be
defined as the undo transaction for the Transaction transaction from the
sub-menu.

8.2.3 Renaming a transaction

To rename a transaction

1. Do one of the following:

• right-click in the lower section of the Transaction sub-tab and select Edit
Transaction from the pop-up menu
• click on the Edit Transaction button .
The Edit Transaction dialog box is displayed.

2. Enter the new name for the transaction in the Transaction name field.

3. Click Finish.

The Transaction sub-tab’s name is updated on the Item Editor tab.

8.2.4 Copying a transaction

To copy a transaction

1. Do one of the following:

• right-click in the lower section of the Transaction sub-tab and select

Copy Transaction from the pop-up menu.
• click on the Copy Transaction button .
The Copy Transaction dialog box is displayed.

2. Enter the name for the new transaction in the Transaction Name field.

3. Click Finish.

© 2024 Nokia Document Version 1.0

 Catalog 30
Release 24
User Guide

The copy of the original Transaction sub-tab (with the new name) is added to
the Item Editor tab.

8.2.5 Deleting a transaction

The last transaction of an item cannot be deleted.

To delete a transaction

1. Do one of the following:

• right-click in the lower section of the Transaction sub-tab and select

Delete Transaction from the pop-up menu
• click on the Delete Transaction button .
You are prompted to confirm the deletion.

2. Click OK.

The transaction is deleted, and the Transaction sub-tab is removed from the
Item Editor tab.

8.2.6 Including items in a transaction

Initially, all embedded items in a transaction are inactive, and are represented by grey
rectangles on the Transaction sub-tab, an example of these is shown in Figure 4. An
item must be activated before it can be configured.

To activate an item

1. Right-click on the relevant item on the Transaction sub-tab, and select

Transactions (followed by the appropriate transaction type) from the pop-up
menu.

The transaction types that are available for selection are determined by the
selected object.

The selection of a transaction type activates the item; its colour changes to
blue, and the visual representation is expanded to include the messages and
parameters, as shown in Figure 5. The transaction type that was selected is
shown in angle brackets.

Messages might be collapsed by default (see Section 3.3 User preferences), in which
case you need to expand them if you want to see the parameters (see Section
8.4.3 Expanding messages).

© 2024 Nokia Document Version 1.0

 Catalog 31
Release 24
User Guide

Figure 5. Example view of an activated item

To create a valid item, you must create mappings between the messages and
parameters of the constituent items in your transaction. For more information on
mappings, see Section 8.4.1 Creating message mappings and Section 8.5.3 Creating
parameter mappings. It is these messages that make up the transaction. You must
ensure that all necessary parameters are passed between individual items and that
they are configured correctly. Mappings are indicated by solid and dashed arrows
linking messages and parameters respectively.

You can use the Errors section of the Properties tab in the Properties and Search
area (an example of which is shown in Figure 6) to help you identify any problems
with a transaction.

Figure 6. Example view of the Errors section of the Properties tab

© 2024 Nokia Document Version 1.0

 Catalog 32
Release 24
User Guide

8.3 Automatic mapping

The Catalog Designer attempts to automatically map the transactions, messages and
parameters of items when they are embedded (this behaviour is configurable – see
Section 3.3 User preferences).

Transactions are mapped by name. Messages and parameters are mapped based on
each item’s dependencies and capabilities and on the parameters defined on each
message.

If the transaction of an embedded item cannot be automatically matched, a transaction

can be selected manually and the automatic mapping of messages and parameters can
be applied manually.

Note Automatic mapping is a best guess and may need to be modified.

8.3.1 Manually applying automatic mapping

To apply automatic mapping manually

1. Right-click on the embedded item to map in the lower section of the

Transaction sub-tab and select Auto Map Item from the pop-up menu.

The messages and parameters of the item are automatically mapped.

This can impact existing mappings.

2. Click the Save button .

8.3.2 Removing automatic mapping

To remove automatic mapping

1. Right-click on the embedded item whose mapping is to be removed in the

lower section of the Transaction sub-tab and select Auto Unmap Item from
the pop-up menu.

The messages and parameters of the item are automatically unmapped.

This can impact existing mappings.

2. Click the Save button .

8.3.3 Mapping highlighting

Highlighting can be used to simplify the message and parameter mappings on the
Transaction sub-tab of the Item Editor tab.

© 2024 Nokia Document Version 1.0

 Catalog 33
Release 24
User Guide

The Highlight Mode On/Off button is used to turn on highlight mode. Turning
on highlight mode highlights the current selection and all its mappings:
• If a parameter is selected, that parameter and the one(s) to which it is mapped are
highlighted.
• If a message is selected, that message and its parameters and the message(s) and
parameters to which they are mapped are highlighted.
• If an item is selected, that item and its messages and parameters and the item(s)
and messages and parameters to which they are mapped are highlighted.

In the Transaction sub-tab of the Item Editor tab, highlighted text is shown in blue,
and the arrows that represent message and parameter mappings are also shown in
blue. The rest of the text and mapping arrows are shown in grey.

Note For specific information on parameter and message mapping, see Section
8.4 Messages and Section 8.5 Parameters.

8.4 Messages
Messages represent the flow of control between a parent item and its embedded items.
Messages are mapped together to create the runtime configuration (also known as a
message dependency). Messages have a direction, incoming or outgoing, indicated in
the Catalog Designer by a golden arrow (ingoing = and outgoing = ).

If a red square overlays a golden arrow, one or more of the parameters are invalid.

© 2024 Nokia Document Version 1.0

 Catalog 34
Release 24
User Guide

Figure 7. Example of the Provide transaction sub-tab showing message mappings

Note You must map all necessary messages between items in your transaction
before it can be published.

8.4.1 Creating message mappings

Catalog attempts to automatically map messages when an item is embedded.
Alternatively, automatic mapping can be manually triggered for a specific item, see
Section 8.3 Automatic mapping.

To manually map messages

1. Select the message that you want to create a mapping from and drag and drop
it onto the message that you want to map it to.

The individual mapping is added.

You must drag and drop as appropriate to the message direction. For example,
you can drag from one embedded item's Complete message to another
embedded item's Request message, but not from one embedded item's
Request message to another embedded item's Complete message.

© 2024 Nokia Document Version 1.0

 Catalog 35
Release 24
User Guide

2. Click the Save button .

8.4.2 Deleting message mapping

To delete an individual mapping

1. Right-click on the line representing the mapping to be removed in the lower

section of the Transaction sub-tab and select Delete from the pop-up menu.

The individual mapping is removed.

2. Click the Save button .

To remove all mapping from a specific item

1. Right-click on the item whose mapping is to be removed in the lower section

of the Transaction sub-tab and select Auto Unmap Item from the pop-up
menu.

The messages and parameters of the item are automatically unmapped.

This can impact existing mappings.

2. Click the Save button .

8.4.3 Expanding messages

Messages can be expanded at different levels.

To expand a single message

1. Right-click on the message that you want to expand and select Expand
Message from the pop-up menu.

The individual message is expanded.

© 2024 Nokia Document Version 1.0

 Catalog 36
Release 24
User Guide

To expand all messages on an item

1. Right-click on the item for which you want to expand the messages and select
Expand Messages from the pop-up menu.

The messages for the selected item are expanded.

To expand all messages

1. Do one of the following:

• right-click in the background of the lower section of the Transaction

sub-tab (after ensuring that nothing is selected) and select Expand All
Messages from the pop-up menu
• click on the Expand All Messages button .
The messages are all expanded.

8.4.4 Collapsing messages

Messages can be collapsed at different levels.

To collapse a single message

1. Right-click on the message that you want to collapse and select Collapse
Message from the pop-up menu.

The individual message is collapsed.

To collapse all messages on an item

1. Right-click on the item for which you want to collapse the messages and
select Collapse Messages from the pop-up menu.

The messages for the selected item are collapsed.

© 2024 Nokia Document Version 1.0

 Catalog 37
Release 24
User Guide

To collapse all messages

1. Do one of the following:

• right-click in the background of the lower section of the Transaction

sub-tab (after ensuring that nothing is selected) and select Collapse All
Messages from the pop-up menu
• click on the Collapse All Messages button .
The messages are all collapsed.

8.5 Parameters
A parameter is a value that is passed between two separate messages in a transaction.
Dashed arrows represent mappings between parameters.

Mandatory parameters (item and transaction parameters) that have no value assigned
are shown in red text. Values can be preconfigured as default values, or specified
from the input mapping from another parameter. If the input parameter originates
from an embedded item, this must also have an available value.

Item Parameters

Parameters can be defined against an item. These parameters are included in the
GetItemSummaryResponse, GetItemDetailsResponse and
GetItemDecompositionResponse in the Catalog API. These parameters can be
used by Business Service Tool via the BST Interface for Catalog and Order
Management when performing Catalog Driven Fulfillment. For more information,
refer Business Service Tool User’s Guide or Online Help.

Transaction Parameters

Parameters can be defined against a transaction. These parameters are included in the
GetItemSummaryResponse, GetItemDetailsResponse and
GetItemDecompositionResponse in the Catalog API. These parameters can be
used by Business Service Tool via the BST Interface for Catalog and Order
Management when performing Catalog Driven Fulfillment. For more information,
refer Business Service Tool User’s Guide or Online Help and FlowOne Fulfillment
Catalog-driven Fulfillment Reference Guide.

© 2024 Nokia Document Version 1.0

 Catalog 38
Release 24
User Guide

Figure 8. Example of the Provide transaction sub-tab showing parameter

mappings

Note You must map all necessary parameters between items in your transaction
before it can be published.

8.5.1 ParameterView tab

The ParameterView tab in the Trees and Lists area contains an instance of each
parameter stored in Catalog. You can use drag and drop to move parameters from
here onto messages in the in the Transaction bar on the Transaction sub-tab rather
than creating new parameters. A parameter needs to be edited to update the
mandatory flag.

At the top of the ParameterView tab is a Favourite Parameters area. This area can
be used to place parameters that are reused often. You can add parameters to the
Favourite Parameters area by ‘dragging and dropping’ from the list or by
right-clicking on a parameter in the list and selecting Add To Favourites from the
pop-up menu. Parameters can be removed from the Favourite Parameters area by
right-clicking and selecting Remove From Favourites from the pop-up menu.

© 2024 Nokia Document Version 1.0

 Catalog 39
Release 24
User Guide

The list of parameters can be filtered by Name. Wildcards * and ? can be used to
represent multiple characters and a single character respectively. The filter is case
insensitive.

8.5.2 Parameter types

The type of each parameter is indicated by the icon that prefixes the parameter name
(for example, see Figure 5). Possible parameter types are detailed in Table 15.

Table 15. Supported parameter types

Icon Type Description
String A character string.

Long 9223372036854775807 to -9223372036854775808. Where a sign is

omitted, + is assumed.
Decimal Arbitrary precision decimal number. Where a sign is omitted, + is
assumed. Leading and trailing zeros are optional. If the fractional part is
zero, the period and trailing zeros can be omitted.
Float 32-bit floating point type – legal literals.

Boolean Binary valued logic legal literal. For example, true, false, 1 or 0.

Hex Binary Arbitrary hex-encoded binary data, For example, OFB7 is a

hex-encoding for the 16-bit integer 4023 (binary 111110110111).
Base 64 Binary Base 64-encoded arbitrary binary data.

Date Time Specific instant of time in the format CCYY-MM-DDThh:mm:ss. For

example, to indicate 1.30 pm on May 7th 2008 in Eastern Standard
Time (5 hours behind Co-ordinated Universal Time) use
2008-05-07T13:30:00-05:00.
Time An instant in time that recurs every day. For example 1:30 pm Eastern
Standard Time (5 hours behind Co-ordinated Universal Time) use
13:30:00-05:00.
Date Calendar date in the format CCYY-MM-DD. For example, May 7th
2008 is 2008-05-07.
Unknown The parameter type is not recognised.

8.5.3 Creating parameter mappings

Catalog attempts to automatically map parameters when an item is embedded.
Alternatively, automatic mapping can be manually triggered for a specific item, see
Section 8.3 Automatic mapping.

A parameter mapping implies a mapping between the two associated messages.

Consequently, creating a parameter mapping automatically creates a corresponding
message mapping.

© 2024 Nokia Document Version 1.0

 Catalog 40
Release 24
User Guide

To manually map parameters

1. In the Transaction sub-tab of the Item Editor tab, select the parameter that
you want to create a mapping from and drag and drop it onto the parameter
that you want to map it to.

The individual mapping is added.

Note You must drag and drop as appropriate to the message direction. For
example, you can drag a parameter from one embedded item's
Complete message to a parameter in another embedded item's
Request message, but not from a parameter in one embedded item's
Request message to a parameter in another embedded item's
Complete message.

2. Click the Save button .

8.5.4 Deleting parameter mappings

To delete an individual mapping

1. Right-click on the line representing the mapping to be removed in the lower

section of the Transaction sub-tab and select Delete from the pop-up menu.

The individual mapping is removed.

2. Click the Save button .

To remove all mapping from a specific item

1. Right-click on the item whose mapping is to be removed in the lower section

of the Transaction sub-tab and select Auto Unmap Item from the pop-up
menu.

The messages and parameters of the item are automatically unmapped.

This can impact existing mappings.

2. Click the Save button .

© 2024 Nokia Document Version 1.0

 Catalog 41
Release 24
User Guide

8.5.5 Parameter mapping wizard

The parameter mapping dialog allows the user to define parameter mappings using a
parameter mapping Wizard rather than via drag and drop. Mappings can be activated
at three different levels:
• Message dependency - where a single Wizard page represents the message
dependency.
• Message - where there is a Wizard page for each message dependency involving
the selected message.
• Embedded item - where there is a Wizard page for each message dependency
involving any of the messages on the selected embedded item.

To map parameters for a message dependency

1. Create a valid local item which includes at least one simple remote item.
Make sure this remote item has at least one parameter defined on it's request
message.

2. On the local item's Transaction tab, right click on the request message and
select Map Parameters on the pop-up menu. This dialog represents the single
message dependency.

3. The Parameter Mappings Wizard opens. The top section of the dialog
details the item - message mapping.

For example:
From local item name - Request
To remote item name - Request

4. A table with two columns (From and To) is displayed. The From column
details all parameters in the local item - request message. The To column
shows the target parameter(s) for any message mappings you have set.

5. In the From column you can change parameter mappings by clicking on the
parameter and choosing an alternate from the dropdown list.

6. If you have more than one embedded item, click Next and repeat the above
mapping steps for that item.

If the parameters of your embedded items have not been auto-mapped but a
dependency exists between their messages, you can map these parameters by
following the below steps.

© 2024 Nokia Document Version 1.0

 Catalog 42
Release 24
User Guide

To map unmapped parameters

1. On the local item's Transaction tab right click on the request message and
select Map Parameters from the pop-up menu.

Note The lower section of the Wizard has now got active tick-boxes next to
the parameter names that exist on the embedded item. This section
allows you to add parameters from embedded items to the top level
messages.

2. Click Finish.

The dialog closes, the ticked parameters are added to the local item request
message and mapped to the same name parameters on the embedded remote
item.

These check boxes are disabled if matching parameters already exist on the
top level message.

It is possible to map parameters between individual messages of embedded items as

well as the host item.

To map parameters for a message

1. Create a valid local item which has at least two simple remote items with
distinctive names. For example, ‘remote one’ and ‘remote two’. Make sure
these remote items have at least one parameter defined on their request and
complete messages.

2. On the local item's Transaction tab, create the following message

dependencies:

• between the request message of local item and remote one.

• between the request message of local item and remote two.
• between the complete message of remote one and remote two.
• between the complete message of remote two and the complete message
of local item.
3. On the local item's Transaction tab, select the request message of remote two.
Right click on the request message and select Map Parameters from the
pop-up menu.

4. The Parameter Mappings Wizard opens. This first dialog of the Wizard
details the item - message mapping.

© 2024 Nokia Document Version 1.0

 Catalog 43
Release 24
User Guide

For example:

From remote one - Complete

To remote two - Request

The check boxes are not displayed on this inter item message dependency
dialog.

5. Configure your parameter mappings and click Next.

6. This second dialog details the item - message mapping.

For example:

From local item - Request

To remote two - Request

7. For more information on how mappings are handled in this dialog, see To
map parameters for a message dependency in Section 8.5.5 Parameter
mapping wizard.

To map parameters for a whole embedded item

1. Using the above example, select all of the embedded item remote two by
clicking on the blue graphic displaying it's name on the local item's
Transaction tab.

2. Right click and select Map Parameters from the pop-up menu.

3. The Parameter Mappings Wizard opens. This first dialog of the Wizard
details the item - message mapping.

For example:

From remote one - Complete

To remote two - Request

The check boxes are not displayed on this inter item message dependency
dialog.

4. Configure your parameter mappings and click Next.

5. This second dialog details the item - message mapping.

For example:

From local item - Request

To remote two - Request

© 2024 Nokia Document Version 1.0

 Catalog 44
Release 24
User Guide

For more information on how mappings are handled in this dialog, see To
map parameters for a message dependency in Section 8.5.5 Parameter
mapping wizard.

6. Configure your parameter mappings and click Next.

7. This third dialog details the item - message mapping.

For example:

From remote two - Complete

To local item - Complete

8. Configure your parameter mappings and click Finish.

8.5.6 Creating new parameters

If required, you can create new parameters for the messages in your transaction.

To create a new parameter

1. Do one of the following:

• in the Transaction sub-tab, right-click on the message type (Request,

Response or Complete) to which you want to add a new parameter and
select New Parameter from the pop-up menu
• in the Transaction sub-tab, select the message type (Request, Response
or Complete) to which you want to add a new parameter and click the
New Parameter button
The New Parameter dialog box is displayed.

2. Enter a name for your parameter in the Name field.

3. Optionally, enter the namespace in the Namespace field or select an existing

namespace from the drop-own list.

4. Select a type from the Type drop-down list. For the available types, see
Section 8.5.2 Parameter types.

5. Optionally, make your parameter mandatory by selecting the This parameter

is mandatory check box.

6. Specify whether your parameter has a fixed set of possible values:

© 2024 Nokia Document Version 1.0

 Catalog 45
Release 24
User Guide

• If your parameter has a fixed set of values, select the This parameter has
a fixed set of possible values check box. Click Next. Use the Value field
to enter a parameter value and click Add. Your new value is added to the
Values area. Add as many values as you require. You can delete or replace
any values by selecting them in the Values area and clicking the Delete or
Replace button. You can specify a default value by selecting a value from
the Default Value drop-down list. This is populated by the values that
have been added to the Values area.
• If your parameter does not have a fixed set of values, do not select the
This parameter has a fixed set of possible values check box. Optionally,
you can set a default value for your parameter in the Default Value field.
7. Optionally, if your parameter type is long, decimal or float, you can specify a
range of permitted values using the Min Value and Max Value fields.

8. Optionally, enter a description of your new parameter in the Description

field.

9. Click Finish.

Your new parameter is added to the message.

8.5.7 Editing parameters

You can edit parameters defined against messages in the Transaction bar on the
Transaction sub-tab of the Item Editor tab for local items or pseudo-remote items.

To edit a parameter (applies to parameters in local/pseudo-remote items)

1. On the Transaction sub-tab, right-click on the parameter that you want to edit
and select Edit Parameter from the pop-up menu.

The Edit Parameter dialog box is displayed.

2. Modify the parameter settings as required.

3. Click Finish.

4. Click the Save button .

You can also set the default value for parameters in embedded items.

To set the default value (applies to parameters in embedded items)

1. On the Transaction sub-tab, right-click on the parameter for which you want
to set a default value and select Edit Parameter from the pop-up menu.

© 2024 Nokia Document Version 1.0

 Catalog 46
Release 24
User Guide

The Edit Parameter dialog box is displayed.

2. Modify the default value as required.

3. Click Finish.

4. Click the Save button .

If the system parameter Update Default Values On Fixed Items has been set to Yes,
you can update the default values of item, transaction and transaction message
parameters on fixed items.

To update the default value on fixed items

1. Right-click on the parameter for which you want to set a default value and
select Edit Parameter from the pop-up menu.

The Edit Parameter dialog box is displayed.

2. Modify the default value as required.

3. Click Finish.

4. Click the Save button.

8.6 Capabilities
The capability of an item describes the functionality that can be performed by that
item.

You can view an item’s capabilities in the Details sub-tab of that item's Properties
tab in the Properties and Search area (along with its dependencies and exclusions).

8.6.1 Creating capabilities

To create a capability

1. Do one of the following:

• in the Design sub-tab of the Item Editor tab, right-click in the

Capabilities area and select New Capability from the pop-up menu.
• ensure that the Design sub-tab of the Item Editor tab is open and click the
New Capability button
The New Capability dialog box is displayed.

2. Enter a name for the new capability in the Name field.

© 2024 Nokia Document Version 1.0

 Catalog 47
Release 24
User Guide

3. Click Finish.

The new capability is listed in the Capabilities area.

The Capabilities tab in the Trees and Lists area displays a hierarchical view of all
available capabilities. You can drag and drop capabilities from here into the Design
sub-tab of the Item Editor tab.

8.6.2 Promoting a capability

Promoting a capability does not remove the capability from an item, but makes it a
specific external requirement. Consequently, if another user selects your item, they
must resolve the capability.

To promote a capability

1. Double-click on the capability in the Outstanding Capabilities section of the

Properties tab in the Properties and Search area.

The promoted capability is then listed in the Capabilities area in the Design
sub-tab of the Item Editor tab, and the border of any items with that
capability change colour from red to blue.

Note Capability and Dependency promotion is only done manually if you have not
selected Automatically promote capabilities when embedding an item or
Automatically promote dependencies when embedding an item
(respectively) in the Window>Preferences dialog box.

8.7 Dependencies
If an item in the Design sub-tab has a dependency, another item in the Design sub-tab
must have that dependency as a capability to enable the item with the dependency to
function correctly.

You can view an item’s dependencies in the Details sub-tab of that item's Properties
tab in the Properties and Search area (along with its capabilities and exclusions).

Each component of an item is displayed as a coloured box in the Design sub-tab of

the Item Editor tab. The colour of the border of the box indicates whether there are
any outstanding dependencies (or conflicting exclusions – see Section
8.8 Exclusions) for that item; if the border of an item is blue, it has no outstanding
dependencies/conflicting exclusions, but if the border of an item is red, it has one or
more outstanding dependencies/conflicting exclusions.

© 2024 Nokia Document Version 1.0

 Catalog 48
Release 24
User Guide

Figure 9. Example of the transaction sub-tab showing items with resolved and
unresolved dependencies
You must resolve or promote any outstanding dependencies in each item before it can
be published.

8.7.1 Creating dependencies

To create a dependency

1. Do one of the following:

• in the Design sub-tab of the Item Editor tab, right-click in the

Dependencies area and select New Dependency from the pop-up menu.
• ensure that the Design sub-tab of the Item Editor tab is open and click the
New Dependency button
The New Dependency dialog box is displayed.

2. Enter a name for the new dependency in the Name field.

3. Click Finish.

The new dependency is listed in the Dependencies area.

8.7.2 Resolving dependencies

Any item that has a red border around it in the lower section of the Design sub-tab of
the Item Editor tab has outstanding dependencies.

To resolve the individual dependencies for an item

1. In the lower section of the Design sub-tab of the Item Editor tab, select an
item that has a red border.

© 2024 Nokia Document Version 1.0

 Catalog 49
Release 24
User Guide

2. Inspect the Outstanding Dependencies section of the Properties tab in the

Properties and Search area. Figure 10 shows an example of the transaction
sub-tab showing items with resolved and unresolved dependencies and the
associated Outstanding Dependencies section of the Properties tab in the
Properties and Search area.

3. Select a dependency in the Outstanding Dependencies section.

Items that could resolve the selected dependency are displayed in the Possible
Item Candidates section.

4. Do one of the following:

• double-click an item in the Possible Item Candidates section

• select an item in the Possible Item Candidates section and drag and drop
it to the Design sub-tab of the Item Editor tab.

Figure 10. Example of the transaction sub-tab

8.7.3 Promoting dependencies

Promoting a dependency does not remove the dependency from an item, but makes it
a specific external requirement. Consequently, if another user selects your item, they
must resolve the dependency.

© 2024 Nokia Document Version 1.0

 Catalog 50
Release 24
User Guide

To promote a dependency

1. Double-click on the dependency in the Outstanding Dependencies section of

the Properties tab in the Properties and Search area.

The promoted dependency is then listed in the Dependencies area in the

Design sub-tab of the Item Editor tab, and the border of any items with that
dependency change colour from red to blue.

Capability and Dependency promotion is only done manually if you have not selected
Automatically promote capabilities when embedding an item or Automatically
promote dependencies when embedding an item (respectively) in the
Window>Preferences dialog box.

8.8 Exclusions
If an item in the Design sub-tab has an exclusion, no item in the Design sub-tab can
have that exclusion as a capability or the item with the exclusion cannot function
correctly.

You can view an item’s exclusions in the Details sub-tab of that item's Properties tab
in the Properties and Search area (along with its capabilities and dependencies).

If an item has an exclusion, that exclusion is propagated to the container item. If

another item within the container item contains a capability that matches the
exclusion, the items become invalid and their borders change colour from blue to red
in the Design sub-tab of the Item Editor tab.

Note You must resolve any outstanding exclusions in an item before it can be
published.

8.8.1 Creating exclusions

To create an exclusion

1. Do one of the following:

• in the Design sub-tab of the Item Editor tab, right-click in the Exclusions
area and select New Exclusion from the pop-up menu.
• ensure that the Design sub-tab of the Item Editor tab is open and click the
New Exclusion button
The New Exclusion dialog box is displayed.

2. Enter a name for the new exclusion in the Name field.

3. Click Finish.

© 2024 Nokia Document Version 1.0

 Catalog 51
Release 24
User Guide

The new exclusion is listed in the Exclusions area.

8.8.2 Resolving conflicting exclusions

To resolve a conflicting exclusion

1. In the lower section of the Design sub-tab of the Item Editor tab, select an
item that has a red border.

2. Inspect the Conflicting Exclusions section of the Properties tab in the

Properties and Search area. Figure 11 shows an example of the transaction
sub-tab showing items with conflicting exclusions and the associated
Conflicting Exclusions section of the Properties tab in the Properties and
Search area.

3. Select one of the conflicting exclusions in the Conflicting Exclusions area.

The items that conflict with the selected exclusion are listed in the
Conflicting Items area.

4. Right-click on the item that contains the conflicting exclusion in the

Conflicting Items area and select Delete from the pop-up menu.

The conflicting item is removed from the Design sub-tab of the Item Editor
tab.

Figure 11. Example of the transaction sub-tab

© 2024 Nokia Document Version 1.0

 Catalog 52
Release 24
User Guide

8.9 Activity properties

Each item’s transaction has an Activity Properties section. You can define the
duration value and unit for each individual transaction. The duration’s
properties together can be either empty or defined with values. These are available for
all the items.

The Sum up duration values check box is available for a Local Item that has at least
one embedded item. Selecting this check box will automatically calculate the
message mapping path that contains the longest duration values from all valid
embedded items in a local item.

The activity name is available for each transaction and is based on item name and
transaction name by default. For example, MOBILE_CREATE.

Figure 12. Example of Activity Properties section of an item’s transaction

Note You must resolve any error related to the duration for each of the transaction
before it can be published or embedded in another item.

Note The activity name of a copied item will be updated to Copy of

itemName_transactionName after performing the action of Copy Item
of an existing Catalog item. User may modify the item's activity name
accordingly if needed.

© 2024 Nokia Document Version 1.0

 Catalog 53
Release 24
User Guide

8.9.1 Editing activity properties on Catalog item

Do one of the following for the respective item type:

• Remote item:
º Check out
º Check in the remote item when the system parameter Update Values on
Activity Properties is set to Yes in Catalog Operational Client.

• Local item:
º Check out
º Make sure that the item is fixed when the system parameter Update Values
on Activity Properties is set to Yes in Catalog Operational Client.

Figure 13. Editing Activity Properties

8.9.2 Editing duration on check in remote item

To edit the duration properties of a check in remote item

1. Modify the value system parameter called Update Values On Activity

Properties to Yes.

2. Re-login to Catalog Designer.

3. Create a remote item.

© 2024 Nokia Document Version 1.0

 Catalog 54
Release 24
User Guide

4. Right click and select Check In.

5. Click on the Edit link that appears on the right side of the duration unit.

For further actions of editing duration on multiple items, see Section 8.9.5 Editing
duration on embedded items.

8.9.3 Editing duration on non-fixed local item

To edit the duration properties of a non-fixed local item

1. Modify the value system parameter called Update Values On Activity

Properties to Yes.

2. Re-login to Catalog Designer.

3. Create a local item with embedded items and fix the possible errors of the
local item.

4. If auto sum-up duration value is not checked, please ensure the duration value
entered is not less than the total duration value of its embedded items.

For further action of editing duration on multiple items, see Section 8.9.5 Editing
duration on embedded items.

8.9.4 Editing duration on fixed local item

To edit the duration properties of a fixed local item

1. Modify the value system parameter called Update Values On Activity

Properties to Yes.

2. Re-login to Catalog Designer.

3. Create a local item with embedded items and fix the possible errors of the
local item.

4. Right click and select Check In.

5. Right click and select Start Transition.

6. Click on the Edit link that appear on the right side of the duration unit.

For further action of editing duration on multiple items, see Section 8.9.5 Editing
duration on embedded items.

© 2024 Nokia Document Version 1.0

 Catalog 55
Release 24
User Guide

8.9.5 Editing duration on embedded items

To edit duration on embedded items

1. Click on the Edit link that appears on the transaction.

• In the event of parent item is enabling the option of auto sum-up duration
values, new duration entered in embedded item will impact its parent item.
• In the event of parent item is disabling the option of auto sum-up duration
values, new duration entered in embedded item must not be greater than
its parent item.
2. Once a valid duration is entered, click Next.

3. A list of impacted parent items will be displayed on the next page of the Edit
wizard.

4. Click on the Expand All check box to expand the tree view of the parent item
lists.

5. Click on the Auto Sum check box on the desired parent item or Auto Sum
All check box to select all parent items, in order to update its duration value.

6. Click Finish.

Figure 14. Edit duration on embedded items

Note Only parent items with complete embedded items message mapping are valid
for the process of auto sum-up duration values.

© 2024 Nokia Document Version 1.0

 Catalog 56
Release 24
User Guide

9 Designing a selection group

A selection group is a container for a group of items, one of which is dynamically
executed at runtime. Only one item within a selection group is executed. User-defined
rules determine which item is executed and control the conditions under which it is
executed. You define these rules using Boolean logic as part of your selection group
configuration. Each item in a selection group must participate in at least in one
transaction and associate with a rule or group of rules. One item in each selection
group must be set as a default for each transaction; this item is executed if none of the
pre-configured rules evaluate to true at runtime.

9.1 Creating a selection group

To create a selection group

1. Do one of the following:

a) select File > New Selection Group, or

b) click the New Selection Group button .

The New Selection Group Wizard is displayed.

2. Enter a name for the selection group in the Name field.

3. Enter a unique value (integer) in the External ID field.

The External ID is optional; if you do not enter a value, Catalog creates a

random value for the External ID.

If you enter a value which is already in use, you see the following error
message: Failed to create selection group. External id
[entered ID value] already exists.

4. Optionally enter an alias in the Alias field. For more information, see Section
3.3 User preferences.

5. Select which transactions you would like to create for your item. All available
transactions are selected by default. Use the CTRL key to select multiple
transactions. At least one transaction must be selected.

6. In the Create in field navigate to the folder under which the new selection
group should be added.

7. If displayed, select the User Groups that the item should be assigned to.
These are the User Groups that the current user has full access to.

The master User Group is never displayed as all items are added to the
master User Group.

8. Optionally, enter a description in the Description field.

© 2024 Nokia Document Version 1.0

 Catalog 57
Release 24
User Guide

9. Click Finish.

Your new selection group is created with version number 1.0 and appears
under the specified directory on the Items tab of the Trees and Lists area.
The status of the selection group is checked out, which allows configuration
of the selection group.

9.2 Defining a selection group

After you have created a selection group, you need to complete its definition. This is
done in the Selection Group Editor tab of the Design and Configuration area.

Note You can enlarge the Selection Group Editor tab to full screen size by using
the maximise button .

To define a new selection group

1. Double-click on the new selection group in the Items tab of the Trees and
Lists area.

The Selection Group Editor tab for that selection group is opened in the
Design and Configuration area.

2. Drag and drop the relevant items from the Items tab into the Items table on
the Selection Group Editor tab's Design sub-tab.

3. After you have added the items that you require, you must define any
Capabilities, Dependencies and Exclusions for the selection group.

© 2024 Nokia Document Version 1.0

 Catalog 58
Release 24
User Guide

4. Click the Save button to save your newly-designed item.

5. To check in your saved selection group, right-click on the selection group in

the Items tab and select Check In from the pop-up menu.

Note A selection group automatically saves when a change is made to its embedded
items.

9.3 Adding items

When embedding one or more items into a selection group, the dependencies and
exclusions are automatically promoted to the selection group.

In certain circumstances (for example, when interacting with the Business Service
Tool), you might not want to include an item in a selection group. Clicking the Add
Empty Selection button beneath the Items table in the Selection Group Editor tab
of the Design and Configuration area adds a row to the Items table with an item of
(none) and a corresponding transaction of (none). Only one of these rows can be
added to each selection group.

This empty item can have rules applied or be set as the default item on the transaction
tab pages in the same way as the other items in the selection group. For more
information, see Section 10.3 Rules.
If there are more than three embedded items in a Selection Group, pagination buttons
will be visible at the Selection Group Item's transaction area.

© 2024 Nokia Document Version 1.0

 Catalog 59
Release 24
User Guide

9.4 Deleting embedded items

When deleting one or more embedded items, Catalog Designer will examine their
capabilities and dependencies. If any are present in the parent item they are displayed
in a dialog. You can choose which of the capabilities and dependencies to remove
from the parent item along with the embedded items.

Select multiple capabilities and dependencies using the CTRL button, or press Select
All or Deselect All to select all or none of them. Press OK to close the dialog after
making your selection.

9.5 Capabilities
The capabilities of a selection group describe the functionality that can be performed
by the items embedded in that selection group.

You can view a selection group’s capabilities in the Details section of the Selection
Group Editor Design tab (along with its dependencies and exclusions).

9.5.1 Creating capabilities

To create a capability

1. Do one of the following:

• in the Design sub-tab of the Selection Group Editor tab, right-click in the
Capabilities area and select New Capability from the pop-up menu.
• ensure that the Design sub-tab of the Selection Group Editor tab is open
and click the New Capability button.
The New Capability dialog box is displayed.

2. Enter a name for the new capability in the Name field.

3. Click Finish.

The new capability is listed in the Capabilities area.

The Capabilities tab in the Trees and Lists area displays a hierarchical view of all
available capabilities. You can drag and drop capabilities from here into the
Capabilities area of the Design sub-tab of the Selection Group Editor tab.

9.5.2 Promoting a capability

Promoting a capability from an embedded item includes that capability in the
selection group’s definition.

© 2024 Nokia Document Version 1.0

 Catalog 60
Release 24
User Guide

To promote a capability

1. Select an item in the Items table on the Design sub-tab of the Selection
Group Editor.

2. Select the Details section of the Properties tab in the Properties and Search
area.

3. Double-click on the capability in the Capabilities list or drag and drop the
capability from the Capabilities list of the Details section to the Capabilities
area on the Design sub-tab of the Selection Group Editor.

4. The promoted capability is then listed in the Capabilities area in the Design
sub-tab of the Selection Group Editor.

9.6 Dependencies
The dependencies of a selection group describe the functionality that must be
performed by other items when combined with the items embedded in the selection
group for the items to function.

You can view a selection group's dependencies in the Details section of the Selection
Group Editor Design tab (along with its capabilities and exclusions).

9.6.1 Creating dependencies

To create a dependency

1. Do one of the following:

• in the Design sub-tab of the Selection Group Editor tab, right-click in the
Dependencies area and select New Dependency from the pop-up menu.
• ensure that the Design sub-tab of the Selection Group Editor tab is open
and click the New Dependency button.
The New Dependency dialog box is displayed.

2. Enter a name for the new dependency in the Name field.

3. Click Finish.

The new dependency is listed in the Dependencies area.

The Capabilities tab in the Trees and Lists area displays a hierarchical view of all
available capabilities. You can drag and drop capabilities from here into the
Dependencies area of the Design sub-tab of the Selection Group Editor tab.

© 2024 Nokia Document Version 1.0

 Catalog 61
Release 24
User Guide

9.6.2 Promoting dependencies

Promoting a dependency from an embedded item includes that dependency in the
selection group’s definition.

To promote a dependency

1. Select an item in the Items table on the Design sub-tab of the Selection
Group Editor.

2. Select the Details section of the Properties tab in the Properties and Search
area.

3. Double-click on the dependency in the Dependencies list or drag and drop the
dependency from the Dependencies list of the Details section to the
Dependencies area on the Design sub-tab of the Selection Group Editor.

4. The promoted dependency is then listed in the Dependencies area in the

Design sub-tab of the Selection Group Editor.

Dependency promotion is done automatically when an item is embedded in a

selection group.

9.7 Exclusions
The exclusions of a selection group describe the functionality that cannot be
performed by other items when combined with the items embedded in the selection
group for the items to function.

You can view a selection group’s exclusions in the Details section of the Selection
Group Editor Design tab (along with its capabilities and dependencies).

9.7.1 Creating exclusions

To create an exclusion

1. Do one of the following:

• in the Design sub-tab of the Item Editor tab, right-click in the Exclusions
area and select New Exclusion from the pop-up menu.
• ensure that the Design sub-tab of the Item Editor tab is open and click the
New Exclusion button.
The New Exclusion dialog box is displayed.

2. Enter a name for the new exclusion in the Name field.

3. Click Finish.

© 2024 Nokia Document Version 1.0

 Catalog 62
Release 24
User Guide

The new exclusion is listed in the Exclusions area.

© 2024 Nokia Document Version 1.0

 Catalog 63
Release 24
User Guide

10 Configuring a selection group

Once your selection group has been defined, the details of its implementation must be
configured, checked and validated. This resembles the configuration of items – the
items included in your selection group must be activated, mappings created between
the parameters and business logic rules configured.

10.1 Transactions
Transactions define the operations that can be carried out on a selection group. For
example, an ADSL service might have transactions called Provide and Cease, and an
ADSL Router (modem) might have a transaction called Order.

Default transactions are defined using the Catalog system parameter Default
Transactions and are added when a new selection group is created. An item must have
at least one transaction defined, but more transactions can be added as appropriate.

10.1.1 Creating transactions

To create a transaction

1. Do one of the following:

• right-click in the lower section of the Transaction sub-tab and select New
Transaction from the pop-up menu.
• click on the New Transaction button .
The New Transaction dialog box is displayed.

2. Enter a name for your new transaction in the Transaction name field.

3. Click Finish.

A new Transaction sub-tab (with the appropriate name) is added to the Item
Editor tab.

10.1.2 Configuring an undo transaction

If a transaction fails during processing, Catalog attempts to undo any transactions on
the embedded items that have already completed. Catalog can only do this if another
transaction has been configured as the undo transaction.

To configure an undo transaction

1. Right-click in the lower section of the Transaction sub-tab and select Undo
Transaction from the pop-up menu, then select the transaction that is to be
defined as the undo transaction for the Transaction from the sub-menu.

© 2024 Nokia Document Version 1.0

 Catalog 64
Release 24
User Guide

10.1.3 Renaming a transaction

To rename a transaction

1. Do one of the following:

• right-click in the lower section of the Transaction sub-tab and select Edit
Transaction from the pop-up menu
• click on the Edit Transaction button .
The Edit Transaction dialog box is displayed.

2. Enter the new name for the transaction in the Transaction name field.

3. Click Finish.

The Transaction sub-tab's name is updated on the Item Editor tab.

10.1.4 Copying a transaction

To copy a transaction

1. Do one of the following:

• right-click in the lower section of the Transaction sub-tab and select

Copy Transaction from the pop-up menu.
• click on the Copy Transaction button .
The Copy Transaction dialog box is displayed.

2. Enter the name for the new transaction in the Transaction Name field.

3. Click Finish.

The copy of the original Transaction sub-tab (with the new name) is added to
the Item Editor tab.

10.1.5 Deleting a transaction

The last transaction of an item cannot be deleted.

To delete a transaction

1. Do one of the following:

• right-click in the lower section of the Transaction sub-tab and select

Delete Transaction from the pop-up menu

© 2024 Nokia Document Version 1.0

 Catalog 65
Release 24
User Guide

• click on the Delete Transaction button .

You are prompted to confirm the deletion.

2. Click OK.

The transaction is deleted, and the Transaction sub-tab is removed from the
Item Editor tab.

10.1.6 Selecting embedded item transaction

When an item is embedded into a selection group Catalog attempts to automatically
map transactions. If this cannot be done or needs modification, the transaction should
be selected manually.

To select the embedded item transaction

1. In the Transaction sub-tab of the Selection Group Editor tab, select the
Items sub-tab.

2. Select the transaction from the Transaction drop down.

10.2 Parameters
Like items, parameters in selection groups are mapped between messages, however in
selection groups the mappings are simply between the selection group and each
embedded item separately.

Selection Group Parameters

Parameters can be defined against a selection group. These parameters are included in
the GetItemSummaryResponse, GetSelectionGroupDetailsResponse and
GetItemDecompositionResponse in the Catalog API. These parameters can be
used by Business Service Tool via the BST Interface for Catalog and Order
Management when performing Catalog Driven Fulfillment. For more information,
refer Business Service Tool User’s Guide or Online Help.

Transaction Parameters

Parameters can be defined against a transaction. These parameters are included in the
GetItemSummaryResponse, GetSelectionGroupDetailsResponse and
GetItemDecompositionResponse in the Catalog API. These parameters can be
used by Business Service Tool via the BST Interface for Catalog and Order
Management when performing Catalog Driven Fulfillment. For more information,
refer Business Service Tool User’s Guide or Online Help.

© 2024 Nokia Document Version 1.0

 Catalog 66
Release 24
User Guide

10.2.1 Creating parameter mappings

Catalog attempts to automatically map parameters (creating parameters on the
selection group transaction if required) when an item is embedded in a selection
group or when an embedded item transaction is selected.

To manually map parameters

1. In the Transaction sub-tab of the Selection Group Editor tab, select the
Parameter Connections sub-tab.

If creating a request parameter mapping:

• In the row of the to parameter of the mapping, select the from parameter in
the drop down in the Source Parameter column of the Request table.
If creating a complete parameter mapping:

• In the row of the from parameter of the mapping, select the to parameter in
the drop down in the Target Parameter column of the Complete table.
2. Click the Save button .

10.2.2 Deleting parameter mappings

To delete a parameter mapping

1. In the Transaction sub-tab of the Selection Group Editor tab, select the
Parameter Connections sub-tab.

If deleting a request parameter mapping:

• In the row of the to parameter of the mapping, select the (none) in the
drop down in the Source Parameter column of the Request table.
If deleting a complete parameter mapping:

• In the row of the from parameter of the mapping, select the (none) in the
drop down in the Target Parameter column of the Complete table.
2. Click the Save button .

10.2.3 Creating new parameters

You can create new parameters for the messages in your selection group transaction.

Selection Group Message Parameters are lists of parameters similar to those in the
Request/Complete Message balloons of the host Item represented in a tabular format.

© 2024 Nokia Document Version 1.0

 Catalog 67
Release 24
User Guide

On the Selection Group Transaction tab it is possible to add additional Parameters to

the Selection Group Message Parameters section in addition to those that have been
promoted from the Embedded Items. You can add these new parameters into the
Request and Complete table sections as required.

Request Message table:

Any new Parameters added to the Request Message table become available in the
Parameter Connections > Request table > Source Parameter column and are
accessed via a drop-down box. The drop-down box is accessed by clicking on the
Parameter name in the Source Parameter column.

It is also possible to change the source mapping of Parameters in a Selection Group

and pass their values into differing parameters on the Embedded Items. The usual
limitations on Parameter mapping apply (for example, types must match String to
String and Long to Long). This limitation is already applied to the dropdown in that if
you choose to remap a String Parameter only String Parameter types are available in
that dropdown.

Changing the Default value of Parameters in the SGMP > Request table should
have these changes mirrored in the Items > (Embedded Item tab) Request table.

Complete Message table:

The above statement from Request Message table is true for the Complete table also,
however, in Complete Message table the Target Parameter column has the dropdown
selection on Parameters available as this represents the host Items Complete Message.

© 2024 Nokia Document Version 1.0

 Catalog 68
Release 24
User Guide

Changing the Default value of Parameters in the SGMP > Complete table should have
these changes mirrored in the Items > (Embedded Item tab) Complete table.

To create a new parameter

1. Do one of the following:

• in the Transaction > Selection Group Message Parameters sub-tab,

right-click on any row of the table belonging to the Request or Complete
message type, where you want to add a new parameter, and select New
Parameter from the pop-up menu.
• in the Transaction > Selection Group Message Parameters sub-tab,
right-click on any row of the table belonging to the Request or Complete
message type, where you want to add a new parameter, and click the New
Parameter button.
The New Parameter dialog box is displayed.

2. Enter a name for your parameter in the Name field.

3. Optionally, enter the namespace in the Namespace field or select an existing

namespace from the drop-own list.

4. Select a type from the Type drop-down list. For the available types, see
Section 8.5.2 Parameter types.

5. Optionally, make your parameter mandatory by selecting the This parameter

is mandatory check box.

6. Specify whether your parameter has a fixed set of possible values:

• If your parameter has a fixed set of values, select the This parameter has
a fixed set of possible values check box. Click Next. Use the Value field
to enter a parameter value and click Add. Your new value is added to the
Values area. Add as many values as you require. You can delete or replace
any values by selecting them in the Values area and clicking the Delete or
Replace button. You can specify a default value by selecting a value from
the Default Value drop-down list. This is populated by the values that
have been added to the Values area.
• If your parameter does not have a fixed set of values, do not select the
This parameter has a fixed set of possible values check box. Optionally,
you can set a default value for your parameter in the Default Value field.
7. Optionally, if your parameter type is long, decimal or float, you can specify a
range of permitted values using the Min Value and Max Value fields.

8. Optionally, enter a description of your new parameter in the Description

field.

© 2024 Nokia Document Version 1.0

 Catalog 69
Release 24
User Guide

9. Click Finish.

Your new parameter is added to the message.

10.2.4 Editing parameters

You can edit parameters defined against messages in the Transaction > Selection
Group Message Parameters sub-tab of the Selection Group Editor tab.

To edit a parameter (applies to selection group)

1. On the Transaction sub-tab, right-click on the parameter that you want to edit
and select Edit Parameter from the pop-up menu.

The Edit Parameter dialog box is displayed.

2. Modify the parameter settings as required.

3. Click Finish.

4. Click the Save button .

You can also set the default value for parameters in embedded items.

To set the default value (applies to parameters in embedded items)

1. In the Transaction sub-tab of the Selection Group Editor tab, select the
Items sub-tab.

2. Click in the Default Value column in the Request or Complete table for the
parameter where you wish to modify the default value.

3. Modify the default value as required.

4. Click the Save button .

10.3 Rules
Rules determine which item is included at runtime. When defining rules (see Section
10.3.1 Defining a rule):
• a default item must be specified for each transaction – the embedded item that is
specified as the default within the transaction is executed if none of the rules
within the transaction evaluate to true.

© 2024 Nokia Document Version 1.0

 Catalog 70
Release 24
User Guide

• a rule must be associated with each item for each transaction with the exception of
the item that is defined as the default item – items (including the empty selection)
which are set as default do not require a rule to be defined.

Rules are evaluated in the order that the embedded items are listed in the Items table
on the Design subtab of the Selection Group Editor tab of the Design and
Configuration area. Two buttons beneath the Items table can be used to change the
order in which the items are listed:
• Move Up – moves the selected item one place higher in the evaluation order.
• Move Down – moves the selected item one place lower in the evaluation order.

10.3.1 Defining a rule

Rules are constructed by building up a series of one or more groups and conditions.
Each rule hierarchy must comprise at least one parent group containing all subsequent
rules and groups. Rules are constructed using logical AND and/or logical OR
conditions.

To define a rule

1. In the Transaction sub-tab of the Selection Group Editor tab, select the
Items sub-tab.

2. The rules are displayed in the Rules area.

© 2024 Nokia Document Version 1.0

 Catalog 71
Release 24
User Guide

3. Right-click on a possible rule in the Rules area and either add a new rule
group (by selecting Add Group from the pop-up menu and populating the
New Rule Group Details dialog box) or add a new condition (by selecting
Add Condition from the pop-up menu and populating the New Condition
dialog box).

• A group must contain one or more conditions or groups that are evaluated
to determine whether your rule has been passed or failed. Choose your
rule group type (AND or OR) using the Rule Group Type drop-down list
in the New Rule Group Details dialog box.

• A condition consists of a statement with a left-hand side (the LHS field)

and a right-hand side (the RHS field), in addition to which an operator
must be selected from the Operator drop-down list. The following
operators are available:
Operation Action
= Is equal to
> Is greater than
>= Is greater than or equal to
< Is less than
<= Is less than or equal to
!= Is not equal to
startsWith The condition is met if the LHS parameter value starts with the RHS
parameter value or literal (the value is case-sensitive).
endsWith The condition is met if the LHS parameter value ends with the RHS
parameter value or literal (the value is case-sensitive).
contains The condition is met if the LHS parameter value contains the RHS
parameter value or literal (the value is case-sensitive).

© 2024 Nokia Document Version 1.0

 Catalog 72
Release 24
User Guide

Operation Action
isSet The condition is met if the LHS parameter has a value defined (that is, is
not null or empty). In this situation, the RHS of the condition is not
displayed as it is not required.
notSet The condition is met if the LHS parameter does not have a value defined
(that is, is null or empty). In this situation, the RHS of the condition is
not displayed as it is not required.
regex The condition is met if the LHS parameter value matches the regular
expression pattern – only a literal value can be provided. For more
information on regex patterns, refer to Javadoc.

4. Repeat step 3 to add groups and conditions to each embedded item on each
transaction.

5. Select the embedded item that is to be the default item for each transaction
and select the Default check box. This is the item that will be executed by
default if all rules evaluate to false.

6. Click the Save button .

10.4 Activity properties

Each item's transaction has an Activity Properties section. However, the duration
value and duration unit are not editable, as the values depends on the embedded
items.

© 2024 Nokia Document Version 1.0

 Catalog 73
Release 24
User Guide

The type of auto sum that are available for Selection Group item are DEFAULT and
LONGEST. DEFAULT auto sum type selects duration values from the default
embedded item; LONGEST auto sum type selects the longest duration values among
the embedded item.

10.4.1 Editing duration auto sum type on check in selection group item

To edit the duration auto sum type of a check in selection group item

1. Modify the value system parameter called Update Values On Activity

Properties to Yes.

2. Re-login to Catalog Designer.

3. Create a selection group item with embedded items and fix the possible errors
of the selection group item.

4. Right click and select Check In.

5. Click on the Edit link that appear on the right side of the duration unit.

For further actions of editing duration on multiple items, see Section 10.4.2 Editing
duration on embedded items.

Figure 15. Edit duration auto sum type of check in selection group item

© 2024 Nokia Document Version 1.0

 Catalog 74
Release 24
User Guide

10.4.2 Editing duration on embedded items

To edit the duration properties of embedded items

1. Click on the Edit link that appear on the transaction.

2. Once the desired duration auto sum type is selected, click Next.

3. A list of impacted parent items will be displayed on the next page of the Edit
wizard.

4. Click on the Expand All check box to expand the tree view of the parent item
lists.

5. Click on the Auto Sum check box on the desired parent item or Auto Sum
All check box to select all parent items in order to update its duration value.

6. Click Finish.

Figure 16. Edit duration on embedded items

© 2024 Nokia Document Version 1.0

 Catalog 75
Release 24
User Guide

11 Extracting items to XML

The Extract to XML button allows the user to select one or more local items to
be extracted to XML files. The format of XML files is that same as the output from
the getItemSummary operation of the Catalog API web service.

To extract one or more items to XML

1. Do one of the following:

• select Extract > Extract to XML, or

• click on the Extract to XML button .
The Extract To XML dialog box is displayed.

2. Choose the method of selection for items to be extracted to XML:

• Name: allows the selection of individual items. When selected, the Select
Items page displays a list of all the local items within Catalog that the
current user has permission to see.
• Folder: allows the selection of folder items. When selected, the Select
Folder page displays a nested list of folders. The selected folder must
contain at least one local item. All local items in the selected folder and
any nested folders are included for selection when moving on to the Select
Items page.
• State: allows the selection of items by their state. When selected, the
Select Lifecycle State page displays a drop-down menu with all the
configured lifecycle states in the system. The selected state must contain
at least one local item. All local items in the state are included for
selection when moving to the Select Items page.
On the Select Items page you can restrict the list by using of the filters at the
top. The Type filter restricts the items to those with a matching type. The
Name filter, which accepts wildcards (* and ?), restricts the items by name.
The Latest check box displays only the latest local items.

3. Specify the output directory by clicking the ... button.

4. Click Finish.

The XML for each item is generated individually and written to a file in the
specified output directory. The file name consists of the item's name and
version.

© 2024 Nokia Document Version 1.0

 Catalog 76
Release 24
User Guide

12 Interacting with Business Service Tool

The Business Service Tool requests item decompositions from Catalog through the
BST Interface for Catalog.

12.1 Configuring remote item groups

Remote Item Groups are used in conjunction with the BST Interface for Catalog and
are defined using the tab or view Remote Item Groups within Catalog Designer. This
view displays existing remote item groups and the remote items and parameters
involved in the group.

Double-clicking on an existing Remote Item group or creating a new Remote Item

group opens the group editor for maintaining that group.

Remote items can be dragged and dropped onto the remote items table and can be
reordered.

Parameters can be dragged and dropped onto the parameters table. For each
parameter a rule must be defined. The possible rules are:
• CONCATENATE – The value for this parameter is the concatenation of all the
values of this parameter (if exists on the remote item) from the remote items in the
group in the order specified. An optional delimiter can be specified in the rule
data field.
• OVERRIDE – The value of the parameter comes from the first or last remote item
in the group. The value of FIRST or LAST must be defined in the rule data field.
• FIXED – The value of this parameter are always set to the value defined in the
rule data field.

During the BST Interface for Catalog decomposition step, if items in a single task
group exist in a remote item group, a new single technical service is returned. The
common parameters across the remote items in the group are processed as defined in
the rules. Any parameters which are not common are added to the new technical
service. If there are any common parameters that do not have a rule defined, an error
occurs.

12.2 Processing order

When processing an item decomposition, the Business Service Tool identifies
technical service or technical library items and executes against them. In Catalog
these technical service or technical library items are represented by remote items. The
remote items within an item decomposition are grouped together according to the
order in which they must be processed; for example, an item might require the output
parameters of a second item as its input parameters. This means that the processing
order can comprise some item groups in parallel and others in sequence.

© 2024 Nokia Document Version 1.0

 Catalog 77
Release 24
User Guide

The processing order for an item can be viewed in Catalog’s Processing Order for
<Item> dialog box, which is accessed by right-clicking on the item in the Items tab
of the Trees and Lists area and selecting Show Processing Order from the pop-up
menu. An example of this dialog box is shown in Figure 17.

Figure 17. Example Processing Order for <Item> dialog box

The Processing Order for <Item> dialog box has tabs representing the various
transactions defined against the item. Each transaction tab comprises a table of
parameters (each transaction can have multiple parameters defined against it) and a
processing order diagram for that transaction. If the decomposition includes selection
groups, then any parameters that are involved in selection group rules are displayed in
the table of parameters. For information on rules within selection groups, see
Section 10.3 Rules. The values of parameters can be changed in the table of
parameters; if the check box for a parameter is selected, then that parameter is used
when determining the processing order.

© 2024 Nokia Document Version 1.0

 Catalog 78
Release 24
User Guide

13 Catalog lifecycle for products and services

Catalog enables you to create and manage the lifecycle of all your Catalog items.
Although Catalog is supplied with predefined lifecycle stages, you can design and
implement your own lifecycle stages in the Catalog Operational Client and use them
to manage the development and deployment of your items in your Catalog Designer.

You can create copies and new versions of items in the Items tab of the Trees and
Lists area (you can copy an item to instantiate a new item with the same properties
and transactions as the original item, or you can adapt an existing item by creating a
new version of it).

When you have created new items in the Catalog Designer, you make them available
to other Catalog users by publishing them. After an item has been published it cannot
be changed.

13.1 Catalog lifecycle

All Catalog items follow a lifecycle. This is defined in a series of states. Catalog is
shipped with a set of predefined states that you can use. Alternatively, you can create
your own lifecycle states in the Catalog Operational Client to meet your business
needs. For information on how to create and maintain lifecycle states, refer Catalog
Operational Client User Guide.

The predefined lifecycle stages are:

• Working - Initial state for a new item. The item can be edited but it is not visible
to external systems.
• Testing - An item can be accessed and tested with an external system. If testing
succeeds, the item can be Published. If the testing fails, the item is reverted back
to a Working state for further editing.
• Published - An item is used in production and can no longer be changed.
• Suspended - An item is temporarily suspended and is not accessible to external
systems. The suspended item can be returned back to a Published state or
alternatively declared Outdated if it is not to be used any more.
• Outdated - An item is not used with new customers but can still be used with
current customers.
• Terminated - An item is not used by any customers and it can be removed.

You can identify the lifecycle stage of any item in Catalog Designer by viewing the
Status column on the Items tab of the Trees and Lists area. This is colour-coded to
aid rapid recognition – the colours are configurable and can vary from those
illustrated in this document.

© 2024 Nokia Document Version 1.0

 Catalog 79
Release 24
User Guide

13.2 Publishing items

To make a Catalog item available locally only (for inclusion inside another product or
service), its state must be changed to one that is defined as fixed. In the default
Catalog lifecycle, items are available locally when they have a state of Testing.

To make a Catalog item available for discovery and use by remote systems, its state
must be changed to one that is defined as fixed and published. In the default Catalog
lifecycle, items available for discovery and use by remote systems when they have a
state of Published.

Before an item can be transitioned to a state that is defined as fixed, you must
complete the item's design and configuration and resolve all dependencies and
exclusions.

To publish an item

1. Right-click on the relevant item in the Items tab of the Trees and Lists area,
and select either Start Transition > Published or Start Transition > Testing
from the pop-up menu.

The Start transition dialog box is displayed.

2. Optionally, select the This transition should begin on a scheduled date

check box and then enter the transition date in the Scheduled Date field.

3. Optionally, enter some information in the Comments field.

4. Click OK to start the transition or Cancel to abandon your changes.

If a transition has already been scheduled or started, new transitions can be queued
and will start on completion of the prior transition.

It is possible to move an item from a fixed state to an unfixed state. This is only
possible if the item has not yet been used, for example, the item has not been included
within another item and no transaction has been requested against the item remotely.

You should ensure that your items meet your business needs before publication.

You can create an updated version of a published item using the version control
features of Catalog – see Section 13.3 Version control.

13.3 Version control

When you create a Catalog item or selection group, it is automatically assigned a
version number. This is shown in parentheses after the item name in the Trees and
Lists area and in the item label in the Design and Configuration area.

© 2024 Nokia Document Version 1.0

 Catalog 80
Release 24
User Guide

You can create new versions of local items, pseudo remote items and selection groups
to increment the version number as either a major or minor change.

A major change increments the major version number, for example, 2.0 or 3.0.
A minor change increments the minor version number, for example, 1.1 or 1.2.

Generally you cannot directly update fixed items. Instead, you must create a new
local version, fixing that once your changes are complete. However, if the system
parameter Update Default Values On Fixed Items has been set to Yes, it is
possible to update the default values of item, transaction and transaction message
parameters.

13.3.1 Creating a new version

To create a new version of an item/selection group

1. Right-click on the relevant item or selection group in the Items tab of the
Trees and Lists area, and select New Version from the pop-up menu.

The New Item Version Wizard is displayed.

2. Navigate to the item group under which the new version should be added in
the Create in field.

3. Optionally, update the Description.

4. Use the Change radio buttons to select whether this is a Major or Minor
change.

5. Click Finish to create the new version or Cancel to abandon your changes.

13.4 Copying items

You can create a copy of any local item/pseudo remote item or selection group. This
instantiates a local item or selection group in the initial state with the same properties
and transactions as your original item. There is no persistent relationship between the
original item and the copy. An item or selection group created by copying always has
the version number 1.0.

To create a copy of an item or selection group

1. Right-click on the relevant item or selection group in the Items tab of the
Trees and Lists area, and select Copy Item from the pop-up menu.

The Copy Item Wizard is displayed.

2. Enter a name for your copied item in the Name field. This must be unique.

© 2024 Nokia Document Version 1.0

 Catalog 81
Release 24
User Guide

3. Navigate to the item group under which the new item should be added in the
Create in field.

4. Optionally, enter a Description.

5. Click Finish to create the new item or selection group or Cancel to abandon
your changes.

13.5 Replacing embedded items/selection groups

Once a new version of an item or selection group has been created and fixed it can be
used to replace an item or selection group which has been embedded. There are two
ways this can be done:
• If the item or selection group to be replaced has been embedded in an item or
selection group which is not fixed, the Item Editor or Selection Group Editor
tab can be used – see Section 13.5.1 Using item editor tab.
• If the item or selection group to be replaced exists in many items/selection groups
or the parent item/selection group is fixed, the Items tab of the Trees and Lists
area can be used – see Section 13.5.2 Using items tab of the trees and lists area.

13.5.1 Using item editor tab

Replacing an embedded item using the Item Editor or Selection Group Editor tab
can be undone and redone.

To replace an embedded item in the Item Editor or Selection Group Editor tab

1. Open the Item Editor or Selection Group Editor tab for the embedded item.

2. Right-click on the embedded item to be replaced in the Design sub-tab of the

Item Editor/Selection Group Editor tab and select Replace Embedded
Item from the pop-up menu.

The Replace Embedded Item wizard is displayed,

3. Select the replacement item.

The pages that follow depend on the configuration of the items being
replaced.

4. Select replacement transactions and/or parameters, as appropriate.

Matching transactions and/or parameters are not displayed.

5. Tick the Automatically map transactions, messages and parameters

checkbox, if you want to automatically map the transactions, messages and
parameters. Otherwise, leave the checkbox unticked and proceed to the next
step.

© 2024 Nokia Document Version 1.0

 Catalog 82
Release 24
User Guide

6. Click Finish.

The item and its mappings are replaced as specified.

13.5.2 Using items tab of the trees and lists area

Replacing an embedded item using the Items tab of the Trees and Lists area cannot
be undone.

To replace an item in the Items tab of the Trees and Lists area

1. Right-click on the item to be replaced in the Items tab of the Trees and Lists
area and select Replace Embedded Item from the pop-up menu.

The Replace Embedded Item wizard is displayed, showing all the items that
contain the item to be replaced. Each containing item has a checkbox to
specify whether the embedded item should be replaced. If a containing item is
fixed, a new version must be created. The user must select whether the new
item will have a minor or major version increment.

The pages that follow depend on the configuration of the items being
replaced.

2. Select replacement transactions and/or parameters, as appropriate.

Matching transactions and/or parameters are not displayed.

3. Tick the “Automatically map transactions, messages and parameters”

checkbox, if you want to automatically map the transactions, messages and
parameters. Otherwise, leave the checkbox unticked and proceed to the next
step.

4. Click Finish.

For each containing item, the embedded item and its mappings are replaced as
specified. If the containing item is fixed, a new version is created first.

If there is any of selected containing items being checked-in, the Check Out
dialog box will be displayed. You may enter the Reason and tick the Apply
All checkbox if you want to check out all the items that are checked-in.

13.6 Comparing items

You can use the Comparison window to view the differences between two items,
specifically, the differences in capabilities, dependencies, exclusions, embedded
items, item parameters, transactions, transaction parameters, messages and message
parameters. The content of each item being compared is displayed under that item.

© 2024 Nokia Document Version 1.0

 Catalog 83
Release 24
User Guide

The Comparison window can be opened in two different ways.

To open the Comparison window

1. Select the two items to compare in the Items tab of the Trees and Lists area
Hold the CTRL key when clicking to select multiple items in the Items tab.

2. Right-click on one of the two selected items and select Compare Items from
the pop-up menu.

The Comparison window is displayed.

To open the Comparison window

1. Right-click the first item to compare in the Items tab of the Trees and Lists
area and select Select Left Item To Compare from the pop-up menu.

2. Right-click the second item to compare in the Items tab of the Trees and
Lists area and select Compare To <name of first item> from the pop-up
menu.

The Comparison window is displayed.

13.7 Check in items

You may perform a check in for multiple items located in a particular folder or only to
check in the Where Used item of the selected item.

13.7.1 Check in items in folder

To check in items in folder

1. Right click on the folder and select Check In Items in Folder from the menu.

2. The Check In Items in Folder wizard is displayed, showing all the items that
can be checked in. Each item has a checkbox to specify whether the item
should be checked in. There is a Check In All checkbox to allow user to
select all items to be checked in.

3. Tick the checkbox in Check-In column to select the items need to be checked
in. You may filter the items by Name or Type.

You may also find the Where Used items. To do so, enter both the Where
Used (select Name or Alias) and Version.

4. Click Next to confirm the selected items.

© 2024 Nokia Document Version 1.0

 Catalog 84
Release 24
User Guide

5. Click Finish to check in the selected items.

6. A summary page will display the status of the checked in items. If there is any
failure, it is listed in the table with an error message displayed in the Info
column.

13.7.2 Check in Where Used items

To check in where used item

1. Right click on an item and select Check In Where Used Item from the menu.

2. The Check In Where Used Item wizard is displayed, showing all the items
that contain the item to be checked in. Each containing item has a checkbox to
specify whether it should be checked in. There is a Check In All checkbox to
allow user to select all items to be checked in.

3. Tick the checkbox in Check-In column to select the items need to be checked
in. You may filter the items by Name or Type.

You may also find other Where Used items. To do so, enter both the Where
Used (select Name or Alias) and Version.

4. Click Next to confirm the selected items.

5. Click Finish to check in the selected items.

6. A summary page will display the status of the checked in items. If there is any
failure, it is listed in the table with an error message displayed in the Info
column.

13.8 Update transition on items

You may perform a bulk transition update operation for multiple items located in a
particular folder or only to update transition on the Where Used item of the selected
item.

13.8.1 Updating transition of items in folder

To Update Transition Items in Folder

1. Right click on the folder and select Update Transition of Items in Folder
from the menu.

© 2024 Nokia Document Version 1.0

 Catalog 85
Release 24
User Guide

2. The Update Transition of Items In Folder wizard is displayed, showing all

the items that have valid transition to be updated. Each item has a checkbox to
specify whether the transition should be updated. The Update Transition for
All checkbox allows user to perform transition update for all items.

3. Tick the checkbox in Update Transition column to select the items where
transition need to be updated.

Note You may filter the items by From State, To State, Name or Type.

From State - It is a collection of current status of items listed in the

Update Transition of Items In Folder wizard.

To State - It is a collection of potential transition status of items listed

in the Update Transition of Items In Folder wizard.

4. Click Next to confirm the selected items.

5. Click Finish to update transition of the selected items.

6. A summary page will display the status of the transition-update items. If there
is any failure, it is listed in the table with an error message displayed in the
Info column.

13.8.2 Updating transition Where Used items

To update transition Where Used items

1. Right click on an item and select Update Transition Where Used Item from
the menu.

2. The Update Transition Where Used Item wizard is displayed, showing all
the items that have valid transition to be updated. Each containing item has a
checkbox to specify whether the transition should be updated. The Update
Transition for All checkbox allows user to perform transition update for all
items.

3. Tick the checkbox in Update Transition column to select the items where
transition need to be updated.

© 2024 Nokia Document Version 1.0

 Catalog 86
Release 24
User Guide

Note You may filter the items by From State, To State, Name or Type.

From State - It is a collection of current status of items listed in the

Update Transition Where Used Item wizard.

To State - It is a collection of potential transition status of items listed

in the Update Transition Where Used Item wizard.

4. Click Next to confirm the selected items.

5. Click Finish to update transition of the selected items.

6. A summary page will display the status of the transition update items. If there
is any failure, it is listed in the table with an error message displayed in the
Info column.

© 2024 Nokia Document Version 1.0

 Catalog 87
Release 24
User Guide

14 Troubleshooting
This section describes some of the problems that can occur during the Catalog
Designer operations.

Table 16 lists the possible errors and explains the action(s) to be taken.

Table 16. Possible errors and the corresponding resolution

Item Description
Loading of the items fails after login with Check the catalog.log located at the Catalog
error message "Error Loading Designer installation directory, if the exception is due to
Catalog". "java.lang.OutOfMemoryError", it could be due to
Designer Java heap size is not sufficient where it could
result in out of memory exceptions.
Try to increase Catalog Designer Java heap size:
• Edit Designer.ini located at Catalog Designer
installation directory.
• Add below lines after the last line in
Designer.ini:
--launcher.XXMaxPermSize
<MaxPermSize>
-vmargs
-Xms<Xms>
-Xmx<Xmx>

Example:
--launcher.XXMaxPermSize
256m
-vmargs
-Xms256m
-Xmx1024m
Designer does not opens or throws login Check the catalog.log to see if any error is captured
errors. for login. It was observed that sometimes this log file is
empty. Add -consoleLog to the Designer.ini and
try to connect to Catalog from Designer. The errors will
be captured in the newly opened console window.

© 2024 Nokia Document Version 1.0