Contents

1   About This Guide

The PDB User Guide describes the functionality offered by the Parameter Database (PDB) application. This guide provides an overview of the PDB interfaces and includes procedures and information required to interact with the system.

1.1   Intended Audience

This document is intended for PDB end-users.

Personnel working on Ericsson products or systems must have the training and competence required to perform their work correctly.

1.1.1   Prerequisite Knowledge

Users of this document should have knowledge and experience of the following:

• Node configuration files (LDIF, NETCONF, and so on)
• MIM files
• Linux

1.2   How This Guide is Organized

This document is organized into the following major sections:

1.3   Conventions Used in This Guide

Table 2 provides a list of typographic conventions that may be encountered in this document:

cd /opt/msmw-cds-⇒
cxp-<version>

(1)  The plus sign (+) indicates that you must press the keys simultaneously.

(2)   The use of the forward slash (/) is for Linux and UNIX systems; Windows systems use the backslash (\).

(3)  The use of the ⇒ symbol (character entity ⇒) at the end of a line has a meaning to the human reader, but if copied and pasted from a CPI document to a command line interpreter the symbol must be cut from the code.

1.4   Prerequisites

• PDB has been successfully installed and configured.

  For installation, upgrade, and rollback procedures, refer to the Parameter Database (PDB) Installation Instructions, 1/1531-CXP 902 0212.

• A web browser with JAVA support is available on the client machine.

  Microsoft® Internet Explorer® version 7, or higher, is recommended.

1.5   Comments About the Documentation

Ericsson encourages you to provide feedback, comments, or suggestions so that we can improve the documentation to better meet your needs. With your comments, provide the following:

• Document title
• Document number and revision
• Page number

Please send your comments to your local Ericsson Support.

2   PDB Overview

PDB is the placeholder for configuration information of nodes, baselines and solutions. It contains all of the necessary information to successfully configure IMS nodes within a network environment.

PDB includes a GUI and a CLI that allow you to work directly with configuration data. Some tasks that can be performed using PDB include:

• Provisioning information related to baselines, solutions, nodes, node schemas, node configurations and configuration sets
• Importing schema data from different nodes and associate it to several node revisions
• Importing configuration data in several formats and from different nodes and associate it to several node revisions
• Working with node configurations, add/modify/delete configuration elements
• Defining conditions for exporting configuration elements based on site-specific parameters
• Creating delta configurations based on existing ones, which can be as well manipulated as any other regular configuration
• Exporting configuration data in several formats and for different nodes
• Comparing configurations
• Validating configurations characteristics like cardinality and value formatting
• Viewing information about configuration elements, such as descriptions, cardinality, value patterns and so on
• Provisioning lists of site-specific parameters, thus allowing a configuration to be independent of site-specific information

2.1   PDB GUI

PDB provides a Graphical User Interface (GUI) to manage the parameter database. The GUI is the primary way for users to interact with the system.

After logging in as described in Section 3, the PDB home page is displayed. The home page shows the PDB welcome message or system notifications. See Figure 1.

System notifications are messages drafted by a PDB system administrator to communicate important information to users.

PDB includes a link for IDEAS FEEDBACK on each page. Use to provide ideas on new features or feedback for improvements.

All PDB functionality that is available in the GUI is accessible from the menu options that are always visible on the left side of the window.

The PDB menu provides direct access to the following interfaces:

Help and Support

The PDB GUI includes several links to help and support located in the upper-right corner of the window, under the welcome message.

The following links are available:

PDB Activity Indicator

The PDB GUI includes an activity indicator located at the bottom of the menu options on the left side of the window. The indicator transitions through various colors to reflect the state of PDB requests.

2.1.1   Using Tables

PDB data is presented in tables. Each table uses pagination to divide large data sets. Navigate these tables using the controls () at the bottom of the frame.

The data within each table is sorted in ascending or descending order. The sorting criteria is indicated by the up () or down () arrows in the column headings. You can change the sorting criteria within a table by clicking on the available headings.

2.2   PDB CLI

PDB includes a simple Command-Line Interface (CLI) client that can be used to execute common PDB tasks from a local machine. Two versions of the CLI client are available, one for Linux and one for Windows.

Refer to the PDB Command Line Interface (CLI) Reference, 1/1540-CXP 902 0212 for a complete description of each command.

3   Authentication

Connections to the PDB GUI are encrypted. Before accessing the PDB GUI, you must first log in and authenticate yourself. Logging in to PDB requires a valid user account. For more information on PDB user accounts, refer to the PDB System Administration Guide, 2/1543-CXP 902 0212.

Network connectivity is required for PDB user authentication. If a connection to the authentication server cannot be established, users are denied access to the PDB GUI.

To log in to the PDB GUI:

1. In your web browser, connect to the PDB GUI.

   https://<PDB_IP_ADDRESS>:8181/pdb

   The Parameter Database Login window opens. See Figure 2.

2. Enter the valid PDB user name and password.
3. Click Login.

   The PDB GUI is displayed in your browser window.

3.1   Access Control Lists

PDB supports an Access Control List (ACL) for each configuration, schema, and site-specific list. An ACL sets access rights per user, granting permission to read or modify the associated object. ACLs act cumulatively with the role permissions granted by a system administrator, meaning that a given user would need both the necessary role membership and correct ACL permissions to work with specific configurations, schemas, or site-specific lists.

When a configuration, schema, or site-specific list is first added to PDB, the creating user is designated as the object owner and is granted unrestricted access. These owners or a system administrator are then able to grant access to other users by adding them to the ACL. Without ACL permissions, PDB users will not see the associated object when they log into PDB and will be unable to work with it.

Note:  

ACL permissions extend to all revisions of the same configuration or schema.

The following permissions are granted through the ACL:

Note:  

Users belonging to the pdb_administrators group always have READ, WRITE, and GRANT permissions on every object. Adding or removing an administrator from the ACL does not change their access rights.

Each configuration, schema, and site-specific list has its own ACL that is accessed through the associated workspace.

• For more information on working with node configurations , refer to Section 8.
• For more information on working with multi-solution configurations, refer to Section 11.1.
• For more information on working with configuration schemas, refer to Section 7.1.
• For more information on working with site-specific lists, refer to Section 13.

Working with Access Control Lists involves modifying the set permissions.

3.1.1   Modifying ACL Permissions

Authorized users can modify an ACL to grant or remove permissions.

Modifying an Access Control List requires GRANT privileges. Users with READ or WRITE permissions are able to view the ACL, but cannot make changes.

To modify an ACL:

1. In the corresponding workspace, right-click a configuration, schema, or ACL and select Permissions.

   The ACL Permissions dialog box opens. See Figure 3.

The following table describes the elements of the Permissions dialog box:

2. Modify the ACL permissions as required. See Table 6.
3. Click Apply.

   The permission changes are committed.

   Note:  

   Affected users may have to refresh the PDB GUI to see the changes.

   
   

4   Managing Applications

In PDB, applications, such as HSS, CSCF, PGM and MGW, are used to classify nodes by identifying the major tasks associated with it.

Working with applications involves the following activities:

• Adding a New Application
• Modifying an Application

4.1   Adding a New Application

New applications can be defined in PDB.

To add a new application:

1. In the PDB GUI, select Applications from the menu options on the left.

   The Applications table is displayed. See Figure 4.

The following table describes the different elements forming the Applications interface:

2. Click New.

   An empty application is added to the top of the table in edit mode. See Figure 5.

3. Enter the required information. See Table 7.
4. Click Apply.

   The new application is added to the database.

4.2   Modifying an Application

The properties of existing applications can be modified.

To modify an application:

1. In the PDB GUI, select Applications from the menu options on the left.

   The Applications table is displayed. See Figure 6.

The following table describes the different elements forming the Applications interface:

2. Select an application to modify from the table.

   The Edit button becomes available.

3. Click Edit.

   The selected application is opened in edit mode.

4. Update the node information as required. See Table 8.
5. Click Apply.

   The updated node definition is saved to the database.

Note:  

To remove an application from PDB:

• Select an application to remove from the Applications table.

  The Delete button becomes available.

• Click Delete.

  A confirmation dialog box opens.

• Click OK.

An application that has been assigned to one or more nodes cannot be deleted until all node associations have been removed.

5   Managing Nodes

PDB handles the configuration for Ericsson IMS nodes (such as HSS, CSCF, and MTAS). Working with nodes involves the following activities:

• Adding Node Information
• Modifying Node Information

5.1   Adding Node Information

Adding node information to the PDB database involves the following tasks:

• Defining a New Node
• Defining a New Node Revision
• Associating a Schema with Node Revisions
• Associating a Configuration with Node Revisions

5.1.1   Defining a New Node

New nodes can be defined in PDB.

To add a new node:

1. In the PDB GUI, select Nodes from the menu options on the left.

   The Nodes table is displayed. See Figure 7.

The following table describes the different elements forming the Nodes interface:

2. Click New.

   An empty node is added to the top of the table in edit mode. See Figure 8.

3. Enter the required information. See Table 9.
4. Click Apply.

   The new node is added to the database. New definitions are positioned in the table based on the sorting criteria.

5.1.2   Defining a New Node Revision

New node revisions can be defined in PDB.

To add a new node revision:

1. In the PDB GUI, select Nodes from the menu options on the left.

   The Nodes table is displayed.

2. Select the node to which to you want to add a new revision.

   The Node Revisions table is displayed. See Figure 9.

The following table describes the different elements forming the Node Revision interface:

3. Click New.

   An empty node revision is added to the top of the table in edit mode. See Figure 10.

4. Enter the required information. See Table 10.
5. Click Apply.

   The new node revision is added to the database. New revisions are positioned in the table based on the sorting criteria.

5.1.3   Associating a Schema with Node Revisions

While schemas are associated with a node during the import process, a given schema may not support all revisions of the selected node. Therefore, PDB node editors can directly associate a schema with the supported node revisions.

Note:  

Associating a schema with node revisions requires a user account with READ permission on the schema's ACL.

To associate a schema with node revisions:

1. In the PDB GUI, select Nodes from the menu options on the left.

   The Nodes table is displayed.

2. Select a node from the table.

   The Node Revisions table is displayed.

3. Select a node revision to associate with a schema.

   The Schemas table is displayed. See Figure 11.

The following table describes the elements of the Schemas table:

4. Click Add/Remove.

   A list of schema revisions that are associated with the selected node is displayed in edit mode. See Figure 12.

   Note:  

   Schema revisions are associated with a node during the schema import process. For more information on importing schemas, refer to Section 7.2.

   
   

5. Select the check boxes next to the schema revisions that are compatible with the node revision.
6. Click Apply.

   The selected schema revisions are linked to the node revision.

5.1.4   Associating a Configuration with Node Revisions

Node configurations are associated with a schema during the import process. While a schema may have already been associated with one or more node revisions, a specific configuration using that schema may only be suitable for a subset of the revisions supported by the configuration schema. Therefore, PDB node editors can directly associate a node configuration with the specific node revisions that are supported.

Note:  

Associating a configuration with node revisions requires a user account with READ permission on the configuration's ACL.

To associate a configuration with node revisions:

1. In the PDB GUI, select Nodes from the menu options on the left.

   The Nodes table is displayed.

2. Select a node from the table.

   The Node Revisions table is displayed.

3. Select a node revision to associate with a configuration.

   The Configurations table is displayed. See Figure 13.

The following table describes the elements of the Configurations table:

4. Click Add/Remove.

   A list of configuration revisions is displayed in edit mode. See Figure 14.

   Note:  

   The list of available configurations is derived from the schemas that have already been associated with the node revision. If the selected node revision has not been associated with a schema, this list will be empty. For more information on associating a schema with node revisions, refer to Section 5.1.3.

   
   

5. Select the check boxes next to the configuration revisions that are compatible with the node revision.
6. Click Apply.

   The selected configuration revisions are linked to the node revision.

5.2   Modifying Node Information

Modifying node information in the PDB database involves the following tasks:

• Modifying a Node
• Modifying a Node Revision

5.2.1   Modifying a Node

The properties of existing node definitions can be modified.

To modify a node:

1. In the PDB GUI, select Nodes from the menu options on the left.

   The Nodes table is displayed. See Figure 15.

The following table describes the different elements forming the Nodes interface:

2. Select a node to modify from the table.

   The Edit button becomes available.

3. Click Edit.

   The selected node is opened in edit mode.

4. Update the node information as required. See Table 13.
5. Click Apply.

   The updated node definition is saved to the database.

Note:  

To remove a node definition from PDB:

• Select a node to remove from the Nodes table.

  The Delete button becomes available.

• Click Delete.

  A confirmation dialog box opens.

• Click OK.

When a node is removed from the database, all of the associated node revisions are automatically removed.

5.2.2   Modifying a Node Revision

The properties of existing node revisions can be modified.

To modify a node revision:

1. In the PDB GUI, select Nodes from the menu options on the left.

   The Nodes table is displayed.

2. Select a node from the table.

   The Node Revisions table is displayed.

The following table describes the different elements forming the Node Revision interface:

3. Select a node revision to modify from the table.

   The Edit button becomes available.

4. Click Edit.

   The selected node revision is opened in edit mode.

5. Update the node revision information as required. See Table 14.
6. Click Apply.

   The updated node revision is saved to the database.

Note:  

To remove a node revision from PDB:

• Select a node to remove from the Node Revisions table.

  The Delete button becomes available.

• Click Delete.

  A confirmation dialog box opens.

• Click OK.

6   Working with Solution Baselines

Solution baselines are a controlled collection of node configurations. In PDB, only baseline editors or administrators can add or modify solution baselines. Working with solution baselines involves the following activities:

• Adding Baseline Information
• Modifying Baseline Information

Solution baselines stored in PDB are revision controlled. PDB validates revision levels following Ericsson's standard rules for document handling. A given revision will precede or supersede other revisions of the same solution baseline; this relationship opens a number of operations when working with a revised solution baseline. These operations include:

• Changing the Document State of a Baseline
• Creating a New Baseline Revision

6.1   The Solution Baselines Workspace

The Solution Baselines workspace allows you to carry out tasks with solution baselines.

To access the Solution Baselines workspace, select Solution Baselines from the menu options on the left. See Figure 17.

The workspace is divided into two principal areas as follows:

The following table describes the elements of the Solution Baselines workspace.

(1)  This column is normally hidden. Click Show Details to display this information.

Each row in the Solution Baselines table is selectable. Right-clicking a row opens a context menu where operations specific to the selected baseline can be executed.

6.1.1   Searching for Solution Baselines

The Solution Baselines table can be filtered by performing a search. A number of search criteria are available to help you find specific baselines. PDB reports partial matches on search strings. Use double quotes <" "> to restrict the search to exact matches.

Searches are performed using the search workspace at the top of the Solution Baselines page. See Figure 18.

The following table describes the available search criteria.

To search the Solution Baselines table:

1. In the Solution Baselines workspace, set your search criteria.
2. Click Search.

   The Solution Baselines table is populated with baselines that match the selected criteria.

Search results are retained as you navigate through the web portal. To reset the Solution Baselines table to the default display, click Clear then click Search.

Each solution baseline has a URL. This link provides an external reference to the specific baseline. Following a direct link connects you to the PDB server. After logging in, PDB automatically loads the Solution Baselines workspace and shows the linked baseline.

URLs are automatically generated by PDB. To access a URL, right-click a baseline and select Copy URL.

6.2   Adding Baseline Information

Adding baseline information to the PDB database involves the following tasks:

• Creating a New Solution Baseline
• Adding Node Configurations to a Solution Baseline

6.2.1   Creating a New Solution Baseline

New baselines can be created in PDB.

To create a new baseline:

1. In the Solution Baselines workspace, click New.

   The New dialog box opens. See Figure 19.

The following table describes the different elements forming the New dialog box:

2. Enter the required information. See Table 17.
3. Click Create.

   The new baseline is added to PDB. The Solution Baselines is automatically filtered to display the new baseline.

6.2.2   Adding Node Configurations to a Solution Baseline

Node configurations are added to a solution baseline in the Configurations workspace. For more information on the Configurations workspace, refer to Section 8.1.

To add a node configuration to a solution baseline:

1. In the Configurations workspace, click Add to Solution Baseline.

   The Add a Configuration dialog box opens. See Figure 20.

The following table describes the different elements forming the Add a Configuration dialog box:

2. Enter the required information. See Table 18.
3. Click Add.

   The selected node configuration is added to the specified solution baseline.

6.3   Working with Baseline Revisions

Solution baselines stored in PDB are revision controlled. A given revision will precede or supersede other revisions of the same solution baseline, allowing for a number of revision-specific operations.

These operations include:

• Changing the Document State of a Baseline
• Creating a New Baseline Revision

By default, only the latest revision of each baseline is displayed in the Solution Baselines table. Older revisions are accessible through the revision history or by refining the search criteria. For more information on performing a search, refer to Section 6.1.1.

To view all revisions of a selected baseline, right-click to open the context menu and select Revision > Show Revision History.

A solution baseline must be in a non-preliminary state (FROZ, FREE, WIDR) before a new revision can be created.

6.3.1   Document States

PDB uses a system of document states to provide information on the completeness, quality, and approval status of a particular solution baseline. The document state is indicated by a status code that is part of the baseline metadata. PDB uses the following document states for solution baselines:

6.3.1.1   Changing the Document State

PDB allows you to change the document state of solution baselines.

Solution baselines must follow the following sequence of document states:

PREL > FROZ > FREE > WIDR

Note:  

Only PDB System Administrators can set a baseline to a previous state.

New baselines start in the PREL state where the baseline information can be modified and updated. The document state is changed as the baseline progresses through its lifecycle.

To change the document state of a solution baseline:

1. In the Solution Baselines workspace, right-click a baseline and select Revision > Set to <STATE>.

   Note:  

   If the baseline is not visible, perform a search as outlined in Section 6.1.1.

   
   

   When moving from PREL to FROZ, the Freeze dialog box opens. See Figure 21.

The Freeze dialog box allows you to modify the revision level of the baseline. Here preliminary revisions can be set to a solid state before freezing.

2. Click Freeze.

   The selected baseline is locked and the document state is set to FROZ.

For all other state transitions a confirmation dialog box is displayed.

Click OK to change the document state.

6.3.2   Creating A New Baseline Revision

A locked solution baseline can be updated by creating a new revision. This process creates an unlocked copy of the original baseline at a new revision level. By default, the new revision retains the same name and description as the original baseline. These fields can be modified, if necessary.

To create a new revision of a locked baseline:

1. In the Solution Baselines workspace, right-click a baseline in state FROZ, FREE, or WIDR and select Revision > Create New Revision.

   Note:  

   If the baseline is not displayed, perform a search as outlined in .

   
   

   The New Revision dialog box opens with the next legal revision displayed. See Figure 22.

2. Verify that the proposed name, description, and revision are correct and update as necessary.
3. Click Create New Revision.

   A new revision is created.

6.4   Modifying Baseline Information

Modifying baseline information in the PDB database involves the following tasks:

• Modifying a Solution Baseline
• Deleting a Solution Baseline

6.4.1   Modifying a Solution Baseline

While in PREL state, the following baseline properties can be modified:

• Names
• Document numbers

  If no document number is specified, PDB automatically generates an internal number.

  Note:  

  Document numbers are validated using Ericsson's standard rules for registration notation.

  Subsequent revisions of an existing baseline are locked to the document number of their predecessor.

  
  
• Descriptions

If the solution baseline is in a locked state, only the Description field can be modified.

To edit baseline properties:

1. In the Solution Baselines workspace, right-click a baseline and select Edit.

   Note:  

   If the baseline is not displayed, perform a search as outlined in Section 6.1.1.

   
   

   The Edit dialog box opens.

2. Update the baseline properties as required.
3. Click Apply.

   The updated properties are saved.

6.4.2   Deleting a Solution Baseline

Solution Baselines in the PREL state can be deleted. Deleting a solution baseline does not remove any associated node configurations.

Note:  

Only PDB System Administrators can remove locked solution baselines, including older revisions of a current baseline.

To delete a solution baseline:

1. In the Solution Baselines workspace, right-click a baseline schema and select Delete.

   Note:  

   If the baseline is not displayed, perform a search as outlined in Section 6.1.1.

   
   

   A confirmation dialog box opens.

   Caution!

   Deleting a baseline permanently removes it from PDB.

2. Click OK.

   The solution baseline is deleted.

7   Working with Schemas

Configuration schemas are templates containing all the possible classes, attributes, relationships, and constraints that are part of the configuration of a specific node revision. PDB binds all configurations to the constraints laid out in a configuration schema. This relationship ensures that the elements contained within a configuration are understood by the supported nodes.

Working with configuration schemas can involve the following activities:

• Importing a Schema
• Modifying Schema Properties
• Exporting Schematron Rules
• Deleting a Schema
• Viewing Schema Elements
• Comparing Two Schemas

PDB keeps an Access Control List (ACL) for each schema. All non-administrative users require ACL permissions to view or modify the associated schema. For more information on ACLs, refer to Section 3.1.

Schemas stored in PDB are revision controlled. PDB validates revision levels following Ericsson's standard rules for document handling. A given revision will precede or supersede other revisions of the same configuration schema; this relationship opens a number of operations when working with a revised schema. These operations include the following:

• Changing the Document State of a Configuration Schema
• Importing a New Schema Revision

7.1   The Schemas Workspace

The Schemas workspace allows you to carry out tasks with configuration schemas.

To access the Schemas workspace, select Schemas from the menu options on the left. See Figure 23.

The workspace is divided into two principal areas as follows:

The following table describes the elements of the Schemas workspace.

(1)  This column is normally hidden. Click Show Details to display this information.

Each configuration schema listed in the Schemas table is selectable. Right-clicking on a schema opens a context menu where operations specific to the selected schema can be executed.

7.1.1   Searching for Schemas

The Schemas table can be filtered by performing a search. A number of search criteria are available to help you find specific schemas. PDB reports partial matches on search strings. Use double quotes <" "> to restrict the search to exact matches.

Searches are performed using the search workspace at the top of the Schemas page. See Figure 24.

The following table describes the available search criteria.

To search the Schemas table:

1. In the Schemas workspace, set your search criteria.
2. Click Search.

   The Schemas table is populated with schemas that match the selected criteria.

   Note:  

   PDB automatically stores up to 10 consecutive searches. Use the navigation buttons to move between each search.

   
   

Search results are retained as you navigate through the web portal. To reset the Schemas table to the default display, click Clear then click Search.

Each configuration schema has a URL. This link provides an external reference to the specific schema. Following a direct link connects you to the PDB server. After logging in, PDB automatically loads the Schemas workspace and shows the linked schema.

URLs are automatically generated by PDB. To access a URL and other properties, right-click a schema and select Properties.

7.2   Importing a Schema

A schema is created by importing Management Information Modelling (MIM) files to PDB. These MIM files are produced and delivered by the different Node Development Organizations (NDOs) for each software release.

Schemas are composed of MIMs and support files such as the index and model files that are part of the IS_CM_MIM format.

Once a configuration schema has been imported, a list of the imported files is available from the Schema Details dialog box. To access Schema Details, right-click a schema and select Properties.

PDB supports the following MIM formats:

• IMS_CM_MIM
  • 3.0
  • 2.0
  • 1.0
  • 0.1

  For more information on the IMS CM MIM format, refer to IMS CM MIM Description for TSP Nodes, 17/1550-HSC 113 06 Uen.

• IS_CM_MIM

  For more information on IS CM MIM format, refer to Management Information Modeling in IS, 25/155 19-AZE 101 01/1 Uen E.

• MP_DTD
  • B
  • D
  • E
  • E1
  • F
  • G

  For more information on the MP_DTD format, refer to the MOM DTD, 006 91-APR 901 950 Uen.

• TSP_MIM

  For more information on TSP MIM format, refer to TSP MIM Specification Reference Manual, 1/1553-CXA 110 3387 Uen.

Schemas are an essential part of node configurations and must be imported before working with configuration data.

To import a configuration schema:

1. In the Schemas workspace, click Import.

   The Import dialog box opens. See Figure 25.

The following table describes the elements of the Import dialog box:

2. Enter the required information. See Table 17.
   Stop!

   PM MIM files are not supported by PDB.

3. Click Import.

   PDB performs the following operations when importing a new configuration schema.

   1. PDB imports the data contained within the selected archive and generates a new configuration schema.
   2. PDB performs a validation check during the import process. This check verifies the syntax of the schema files and examines the relationship between configuration elements.

      Note:  

      Structural errors interfere with PDB's ability to parse the incoming files and will cause the import process to fail.

      
      
   3. PDB automatically generates an import validation report when problems are found. Errors and warnings that were found during validation are reported for each affected schema file. This report can be downloaded from the Report Available dialog box that appears at the end of the import process.
   4. PDB stores the schema archive and the import validation report. These files can be downloaded from the properties dialog box for the new schema.

The following example presents a sample import validation report.

HSS_11A_R6A_MIM_CM_001.ZIP Validation Report

FILE VALIDATION REPORT
Filename: sda_cm_mim.xml

WARNING Attribute 'HSS-AdministrativeState' is already defined in class 'HSS-Application'. Skipping it
WARNING Attribute 'HSS-InstallationType' is already defined in class 'HSS-Application'. Skipping it
WARNING Attribute 'HSS-IsDataCacheUsed' is already defined in class 'HSS-Application'. Skipping it
WARNING Attribute 'HSS-TransparentDataLicense' is already defined in class 'HSS-License'. Skipping it
WARNING Attribute 'HSS-PsCsDataRequestLicense' is already defined in class 'HSS-License'. Skipping it
WARNING Attribute 'HSS-GbaLicense' is already defined in class 'HSS-License'. Skipping it
WARNING Attribute 'HSS-ExtDbConfigLogActive' is already defined in class 'HSS-ExtDbConfig'. Skipping it
WARNING Attribute 'HSS-ExtDbConfigUrlList' is already defined in class 'HSS-ExtDbConfig'. Skipping it
WARNING Attribute 'HSS-ExtDbMaxConcurrentClients' is already defined in class 'HSS-ExtDbConfig'. Skipping it
WARNING Attribute 'HSS-ExtDbConfigOrigVipList' is already defined in class 'HSS-ExtDbConfig'. Skipping it
WARNING Attribute 'HSS-ExtDbConfigRootDnList' is already defined in class 'HSS-ExtDbConfig'. Skipping it

----------------

For a description of the messages presented in schema validation reports, refer to MIM Validation Errors in the Appendix.

4. If required, grant permission for other users to work with the new schema by modifying the ACL. For more information on granting ACL permissions, refer to Section 3.1.1.

7.3   Working with Schema Revisions

Schemas stored in PDB are revision controlled. A given revision will precede or supersede other revisions of the same configuration schema, allowing for a number of revision-specific operations.

These operations include:

• Changing the Document State of a Configuration Schema
• Importing a New Schema Revision

By default, only the latest revision of each schema is displayed in the Schemas table. Older revisions are accessible through the revision history or by refining the search criteria. For more information on performing a search, refer to Section 7.1.1.

To view all revisions of a selected schema, right-click to open the context menu and select Revision > Show Revision History.

PDB requires all predecessors to be in a non-preliminary state (FROZ, FREE, WIDR) before subsequent revisions can be created.

7.3.1   Document States

PDB uses a system of document states to provide information on the completeness, quality, and approval status of a particular schema revision. The document state is indicated by a status code that is part of the schema metadata. PDB uses the following document states for node configurations:

7.3.1.1   Changing the Document State

PDB allows you to change the document state of configuration schemas that you have permission to modify. For more information on ACL permissions, refer to Section 3.1.

Schema revisions must follow the following sequence of document states:

PREL > FROZ > FREE > WIDR

Note:  

Only PDB System Administrators can set a schema to a previous state.

New schemas, or schema revisions start in the PREL state where the associated metadata can be modified and updated. The document state is changed as the schema progresses through its lifecycle.

To change the document state of a schema revision:

1. In the Schemas workspace, right-click a schema and select Revision > Set to <STATE>.

   Note:  

   If the schema is not visible, perform a search as outlined in Section 7.1.1.

   
   

   When moving from PREL to FROZ, the Freeze dialog box opens. See Figure 26.

The Freeze dialog box allows you to modify the revision level of the schema. Here preliminary revisions can be set to a solid state before freezing.

2. Click Freeze.

   The selected schema is locked and the document state is set to FROZ.

For all other state transitions a confirmation dialog box is displayed.

Click OK to change the document state.

7.3.2   Importing a New Schema Revision

A revised set of files can be imported to create a new schema revision.

Although a new schema revision supersedes previous revisions of the same configuration schema it does not automatically change any relationships between the former schema revision and node configurations. In order to base existing node configurations on a new schema revision, you must a trigger the schema migration process from the Configurations workspace. For more information on migrating configurations to another schema, refer to Section 8.7.

To import a new schema revision:

1. In the Schemas workspace, right-click a non-preliminary schema and select Revision > Import New Revision.

   The Import New Revision dialog box opens with the next legal revision displayed. See Figure 27.

2. Verify that the proposed revision is correct and update as necessary.
3. Enter the path and file name of the schema archive.
4. Click Import.

   PDB performs the following operations when importing a new configuration schema.

   1. PDB imports the data contained within the selected archive and generates a new configuration schema revision.
   2. PDB performs a validation check during the import process. For more information on the validation check, refer to Section 7.2.
   3. PDB automatically generates an import validation report when problems are found. Errors and warnings that were found during validation are reported for each affected schema file. This report can be downloaded from the Report Available dialog box that appears at the end of the import process.
   4. PDB stores the schema archive and the import validation report. These files can be downloaded from the properties dialog box for the new schema.

7.4   Modifying Schema Properties

While in PREL state, PDB allows you to modify the following schema properties:

• Names
• Document numbers

  If no document number is specified, PDB automatically generates an internal number.

  Note:  

  Document numbers are validated using Ericsson's standard rules for registration notation.

  Subsequent revisions of an existing schema are locked to the document number of their predecessor.

  
  
• Descriptions
• Initial Value List Associations

  For more information on associating an Initial Value List (IVL) with a schema, refer to Section 7.4.1.

If the schema is in a locked state, only the Description and Revision Comment fields can be modified.

To edit schema properties:

1. In the Schemas workspace, right-click a schema in PREL state and select Edit.

   Note:  

   If the schema is not displayed, perform a search as outlined in Section 7.1.1.

   
   

   The Edit dialog box opens.

2. Update the schema properties as required.
3. Click Apply.

   The updated properties are saved.

7.4.1   Associating an Initial Value List with a Schema

An Initial Value List (IVL) represents the configuration of an LDAP node after maiden installation. When exporting a node configuration in LDIF format, PDB will use IVL data associated with the configuration schema to produce configuration files that do not collide with the configuration values that are assumed to already exist in the real node.

Node configurations stored in PDB must be tagged as IVL before they can be associated with a schema. For more information on tagging configurations as IVL, refer to Section 8.6.

To associate an with a configuration schema:

1. In the Schemas workspace, right-click a schema in PREL state and select Edit.

   Note:  

   If the schema is not displayed, perform a search as outlined in Section 7.1.1.

   
   

   The Edit dialog box opens.

2. Under Initial Value List, Select an IVL configuration to associate with the schema.
3. Click Apply.

   The updated properties are saved.

7.5   Exporting Schematron Rules

Schematron rules are used in some NETCONF-based configuration schemas to provide an additional layer of validation. These rules constrain patterns in the configuration XML, ensuring, for example, that related parameter values correspond with each other.

When a configuration schema stored in PDB contains schematron rules, these rules can be exported to an XML file.

To export schematron rules:

1. In the Schemas workspace, right-click a schema containing schematron rules and select Export Schematron.

   Note:  

   If the schema is not displayed, perform a search as outlined in Section 7.1.1.

   
   

   The Export dialog box opens.

2. Click Download Schematron.

   An XML file containing the schematron rules is downloaded. By default, the downloaded XML file uses the following naming convention:

   <schema_name>[<revision>]_schematron.xml

   Where:

   <schema_name		Is the name of the configuration schema that the rules are exported from.
   <revision>		Is the revision of the selected schema in PDB.

7.6   Deleting a Schema

Authorized users can remove schemas from PDB as needed.

Note:  

PDB cannot remove older schema revisions or any schema that has been associated with node revisions. In these cases, you must ensure that the configuration schema is no longer being referenced within PDB before attempting to delete it.

To remove a schema from PDB:

1. In the Schemas workspace, right-click a schema and select Delete.

   Note:  

   If the schema is not displayed, perform a search as outlined in Section 7.1.1.

   
   

   A confirmation dialog box opens.

   Caution!

   Deleting a schema permanently removes it from PDB.

2. Click OK.

   The configuration schema is deleted.

7.7   Viewing Schema Elements

Configuration schemas are composed of parameters and parameter groups that are used to define a valid structure for the associated configurations. Where a specific element exists in the schema, a corresponding element can exist in a configuration using that schema. Each element (parameter or parameter group) is defined with cardinality and value constraints that ensure a configuration will be compatible with the destination node.

To facilitate working with this information, PDB provides a dedicated browser for schema elements. The schema browser is described in Section 7.7.1.

7.7.1   The Schema Browser

The schema browser allows users to view the structure of schema elements in PDB.

Schema elements can be displayed in two possible formats:

• TREE view (Default)
• TABLE view

In the TREE view, PDB displays schema elements as a cascading tree of parameter groups, each group containing one or more parameters.

See Figure 28.

In the TABLE view, PDB displays schema elements as a table of nested parameter groups, each containing one or more parameters. The table includes the following information, where applicable:

• MOC

  The Managed Object Class (MOC) shows the path of the configuration element in the configuration tree.

  Note:  

  Only the last section of the MOC is shown in table view. The full path of the schema element is available as a tooltip.

  
  
• Name
• Description

See Figure 29.

To switch between TREE and TABLE views, make a selection from the Format drop-down list at the top of the page. Selected elements are not affected by switching between views.

To browse a schema in PDB:

• In the Schemas workspace, select a schema to browse and click Open.

  Note:  

  If the schema is not displayed, perform a search as outlined in Section 7.1.1.

  
  

  Elements of the selected schema are displayed in the schema browser.

  To facilitate working with large schemas, the schema browser includes a search functionality that allows you to filter the schema for specific elements. For more information on the search functionality, refer to Section 7.7.1.1.

The following table describes the elements of the schema browser:

7.7.1.1   Searching Configuration Schemas

The schema browser includes a search functionality that locates specific elements using a number of different criteria.

The search field accepts keywords to narrow down the search results. The syntax for using keywords is as follows:

<keyword1>:value1 <keyword2>:value2 <keyword3>:value3 ...

The following table describes the available keywords.

To perform a search:

1. In the schema browser, click Search.

   The Search dialog box is displayed. See Figure 30.

2. Enter your search query.

   For a basic search, type the name of the schema element you are searching for.

   Note:  

   Search strings are not case-sensitive. All searches return a partial match unless the string is surrounded by double quotes.

   
   

   For a keyword search, compose a search string using one or more valid keywords. See Table 23 for a description of the available search options.

   Note:  

   Different keywords can be combined to refine the search pattern.

   Some sample search queries, include:

   • name: <string> type:P

     This query would search for parameters with a name matching the input string.

   • name: <string> type:PG status:deprecated

     This query would search for parameter groups with a name matching the input string that are currently set as deprecated.

   • description: <string>

     This query would search for parameters or parameter groups that contain a description matching the input string.

   • sdn:Root[RootPrimaryKey=0],A1[A1PrimaryKey=0] type:P

     This query would search for parameters located at the specified location in the schema.

   
   
3. Click Search.

   The search hits are listed in the table at the bottom of the Search dialog box. See Figure 31.

   Search results are listed with the following information, where applicable:

   • SDN
   • Parameter Name

4. Click the magnifying glass () next to one of the search results to open the schema at that element's location.

   The search is complete.

   Search results are available in CSV format. Click Export to CSV to download the CSV file.

7.8   Comparing Two Schemas

Using PDB you can compare two configuration schemas to identify certain differences between them. Both parameters and parameter groups are analyzed in a comparison and the following differences can be highlighted:

The schema comparison is useful for identifying these differences between revisions of the same schema.

When performing a comparison, PDB distinguishes between a Base Schema and a Target Schema. The Base Schema serves as the starting point for a comparison. It is contrasted with a Target Schema that may be a previous revision of the Original Schema or a separate schema that has been imported to PDB.

Shortcuts in the Schemas context menu (under Compare > Compare with Previous and Compare > Compare with Another) allow you to generate comparison reports.

Comparison results are output to a table in the Schema Comparison dialog box. This table lists the differences that have been identified between the two schemas. The schema comparison can be downloaded as a Comma Separated Values (CSV) file.

To compare two schemas:

1. In the Schemas workspace, right-click a schema and select one of the following:
   • Compare > Compare with Previous

     Selecting Compare with Previous opens the Schema Comparison dialog box with the previous revision of the base schema selected for comparison.

   • Compare > Compare with Another

     Selecting Compare with Another opens the Schema Comparison dialog box to select the Target Schema. See Figure 32.

2. If required, update the search filters to find the target schema. For more information on the search criteria, refer to Section 7.1.1.
3. Select the target schema and the properties to compare. For more information on the comparison properties, see Table 24
4. Click Compare

   PDB performs the selected comparison and displays the results. See Figure 33.

   The schema comparison is complete.

The schema comparison report is color coded as follows:

• Red highlights missing elements.

  For example:

• Orange highlights value differences.

  For example:

Different shades of the same color are used to distinguish separate rows and do not mark additional information.

The following table describes the different elements of a Schema Comparison:

(1)  To constrain the size of the comparison report, descriptions longer than 50 characters are automatically hidden. Hidden descriptions are identified with descriptive text. To see the full text, hover over a hidden description or export the report to CSV.

Note:  

Values in the table headings mark the number of differences captured in that column.

8   Working with Node Configurations

A node configuration is an organized collection of parameter instances and values that define configuration settings for a specific node. In PDB, node configurations can be created from scratch or imported from configuration files.

PDB can import configuration data in the following file formats:

• LDIF
• NETCONF
• Parameter Value List (PVL)

  Note:  

  PDB supports multi-solution configurations. For more information on working with multi-solution configurations, refer to Section 11.

  
  

PVL formatted files are typically generated by node development organizations while LDIF and NETCONF formatted files are typically extracted from service nodes in the field. For more information on importing node configurations, refer to Section 8.2.

Node configurations must be based on a configuration schema. The schema acts as a template and constrains the content of the associated configurations. The use of schemas ensures the validity of configurations by preventing the entry of invalid data. For more information on configuration schemas, refer to Section 7.

Once a node configuration has been created in PDB, you can work with it in a number of ways including:

• Managing Configuration Data
• Creating a Delta Configuration
• Cloning a Configuration
• Merging Node Configurations
• Migrating a Configuration to Another Schema
• Comparing Two Configurations
• Validating a Configuration
• Exporting a Node Configuration

PDB keeps an Access Control List (ACL) for each node configuration. All non-administrative users require ACL permissions to view or modify the associated configuration. For more information on ACLs, refer to Section 3.1.

All node configurations stored in PDB are revision controlled. PDB validates revision levels following Ericsson's standard rules for document handling. A given revision will precede or supersede other revisions of the same configuration; this relationship opens a number of operations when working with a revised node configuration. These operations include:

• Comparing Different Revision Levels
• Changing the Document State
• Creating a New Revision
• Importing a New Revision
• Rebasing a Delta Configuration

Node configurations can be associated with one or more node revisions that have been defined in PDB. This association ultimately helps to link the configuration to a baseline revision. For more information on associating a configuration with node revisions, refer to Section 5.1.4.

8.1   The Configurations Workspace

The Configurations workspace allows you to carry out tasks with node configurations.

To access the Configurations workspace, select Configurations from the menu options on the left. See Figure 34.

The workspace is divided into two principal areas as follows:

The following table describes the elements of the Configurations workspace.

(1)  This column is normally hidden. Click Show Details to display this information.

Each configuration listed in the Configurations table is selectable. Right-clicking a configuration opens a context menu where operations specific to the selected configuration can be executed.

8.1.1   Searching for Node Configurations

The Configurations table is empty by default and is populated with node configurations by performing a search. A number of search criteria are available to help you find specific configurations. PDB reports partial matches on search strings. Use double quotes <" "> to restrict the search to exact matches.

Searches are performed using the search workspace at the top of the Configurations page. See Figure 35.

The following table describes the available search criteria.

All search filters are additive. Using multiple filters will narrow the search results.

To filter the Configurations table:

1. In the Configurations workspace, set your search criteria.
2. Click Search.

   The Configurations table is populated with configurations that match the selected criteria.

   Note:  

   PDB automatically stores up to 10 consecutive searches. Use the navigation buttons to move between each search.

   
   

Search results are retained as you navigate through the web portal. To reset the Configurations table to the default display, click Clear then click Search.

Each node configuration has a URL. This link provides an external reference to the specific configuration. Following a direct link connects you to the PDB server. After logging in, PDB automatically loads the Configurations workspace and shows the linked configuration.

URLs are automatically generated by PDB. To access a URL and other properties, right-click a configuration and select Properties.

8.2   Importing a Node Configuration

Most of the configuration data included in PDB has been imported from configuration files.

PDB can parse configuration data in the following formats:

Configuration files can be packaged in a ZIP or TAR archive, or imported directly from LDIF or XML files.

Note:  

An archive directory structure is not required by PDB to import configurations; however, if directories are present inside the file, then PDB will recursively scan for configuration files within the directories as needed.

To import a node configuration:

1. In the Configurations workspace, click Import.

   The Import dialog box opens. See Figure 36.

The following table describes the elements of the Import dialog box:

2. Enter the required information. See Table 28.
3. Click Import.

   PDB performs the following operations when importing a new configuration.

   1. PDB imports the data contained within the selected archive and generates a new configuration.
   2. PDB automatically performs a validation check during the import process. This check verifies the syntax of the configuration files and validates the configuration against the selected schema.
   3. PDB generates an import validation report that can be downloaded from the Report Available dialog box that appears at the end of the import process. For a description of the messages presented in import validation reports, refer to Configuration Validation Errors in the Appendix.
   4. PDB stores the configuration archive and the import validation report. These files can be downloaded from the properties dialog box for the new configuration.
4. If required, grant permission for other users to work with the new configuration by modifying the ACL. For more information on granting ACL permissions, refer to Section 3.1.1.

8.3   Creating a New Node Configuration

PDB allows you to create node configurations without importing new data. These configurations are either built from scratch or based on one or more existing configurations.

The following tasks will create a configuration without importing new files:

• Creating an Empty Configuration
• Cloning a Configuration
• Merging Node Configurations

Creating new revisions of an existing configuration is part of revision handling and is fully discussed in Section 8.5.

8.3.1   Creating an Empty Configuration

Empty configurations do not contain any configuration elements when they are first created and must be built from scratch. Data must be manually added to the configuration using the configuration browser. For more information on working with configuration data, refer to Section 9.

To create an empty configuration:

1. In the Configurations workspace, click Create Empty.

   The New dialog box opens. See Figure 37.

The following table describes the elements of the New dialog box:

2. Enter the required information. See Table 29.
3. Click Create.

   The empty configuration is created.

4. If required, grant permission for other users to work with the new configuration by modifying the ACL. For more information on granting ACL permissions, refer to Section 3.1.1.

8.3.2   Cloning a Configuration

Cloning creates a copy of an existing configuration with a new name and revision. A cloned configuration uses the same schema as the original and contains the same configuration data.

In addition, cloning a configuration can optionally replicate any child configurations that hang from the selected parent.

To clone a configuration:

1. In the Configurations workspace, right-click a configuration and select Clone.

   Note:  

   If the configuration is not displayed, perform a search as outlined in Section 8.1.1.

   
   

   The Clone dialog box opens. See Figure 38.

The following table describes the elements of the Clone dialog box:

2. Enter the required information. See Table 30.
3. Click Clone.

   Clones of the selected configuration and the associated deltas (if selected) are created.

   Note:  

   PDB automatically generates an internal document number for the new configuration(s). This number can be modified by editing the configuration properties as described in Section 8.6.

   
   
4. If required, grant permission for other users to work with the new configuration(s) by modifying the ACL. For more information on granting ACL permissions, refer to Section 3.1.1.

8.3.3   Merging Node Configurations

PDB allows you to merge the contents of two or more node configurations into a single configuration. This new configuration can be a root configuration or a delta configuration.

When merging elements into a root configuration, the new configuration must be based on one of the available schemas. This schema is selected during the merge process.

When merging elements into a delta configuration, the new delta is restricted to the same schema as its parent. Any configuration can be selected as a parent for the new delta, including another delta configuration.

Regardless of the resulting configuration (root or delta), if any of the merged elements are invalid under the new schema, they are dropped from the merged configuration.

Up to 10 configurations can be merged at the same time. PDB uses the order of the selected configurations to resolve merge conflicts with configurations located at the top of the list being given more precedence.

PDB performs two types of merge operations:

• Trivial Merges

  Trivial merges are automatically resolved by PDB and include nonconflicting merges of different parameter names and values. Merging parameters groups is always considered a trivial merge since parameter groups with different primary keys are treated a separate entities.

• Non-Trivial Merges

  Non-trivial merges occur when one or more configuration parameters have the same name but different values. By default, these merges are resolved based on the precedence of the merged configurations, with PDB taking the values of the top-most configuration that is in conflict. You can modify these default values during the merge procedure.

To merge configurations:

1. In the Configurations workspace, ensure that the configurations you want to merge are displayed.

   Note:  

   If any of the configurations are not visible, perform a search as outlined in Section 8.1.1.

   
   
2. Click Merge.

   The Merge dialog box opens. See Figure 39.

The following table describes the elements of the Merge dialog box:

Note:  

All items are mandatory.

3. Enter the required information. See Table 31.
4. Click Merge.

   The selected configurations are merged using the default resolution for non-trivial merge conflicts. When the merge is complete, the Merge Report dialog box opens. See Figure 40 for a sample summary.

The Merge Report dialog box provides a summary of the merge and allows you to modify the non-trivial merges.

The Non Trivial Merge Resolution Table lists all of the non-trivial merges that were performed during the selected operation. If required, you can modify the default resolution for each parameter by clicking Manually Select Value and setting a value for each non-trivial merge.

Note:  

If the table is paginated, updates on each page are saved automatically.

5. Click Download Report to download the merge report.

The merge report is a space-separated text file containing a complete list of all actions that were performed to merge the selected configurations. Inside the report, merge activities are recorded in the following format:

<Merge Type> <Element Type> <Action> <MOI>

Example 2 shows an extract of a sample merge report.

# Merged
#
#    Configuration: /HSS_11A_R9B_LDIF/HSS_11A_R9B_NoEmptyValues[PA1]
#    Schema:        HSS_CM_MIM
#
#    Configuration: /HSS_11A_R9B_LDIF[PB1]
#    Schema:        HSS_CM_MIM
#
#
# Target
#
#    Configuration: /HSS_11A_R9B_MergedValues[PA1]
#    Schema:        HSS_CM_MIM
#

  ...
  ...
  TRIVIAL PG ADD   RAD-Application[applicationName=RADIUS],RAD-AppInstance[RAD-ApplicationName=HSS_SM],
   RAD-Vendor[RAD-VendorId=HSS_SM:10415],RAD-Vsa[RAD-VsaId=HSS_SM:10415:6] 
  TRIVIAL P  MERGE RAD-Application[applicationName=RADIUS],RAD-AppInstance[RAD-ApplicationName=HSS_SM],
   RAD-Vendor[RAD-VendorId=HSS_SM:10415],RAD-Vsa[RAD-VsaId=HSS_SM:10415:6]:RAD-VsaFormat [[address]] 
  TRIVIAL P  MERGE RAD-Application[applicationName=RADIUS],RAD-AppInstance[RAD-ApplicationName=HSS_SM],
   RAD-Vendor[RAD-VendorId=HSS_SM:10415],RAD-Vsa[RAD-VsaId=HSS_SM:10415:6]:RAD-VsaName [[3GPP-SGSN-Address]]
NON TRIVIAL P  MERGE RAD-Application[applicationName=RADIUS],RAD-AppInstance[RAD-ApplicationName=HSS_SM],
   RAD-Vendor[RAD-VendorId=HSS_SM:10415]:RAD-LengthSize [[2], [1]] 
NON TRIVIAL P  MERGE RAD-Application[applicationName=RADIUS],RAD-AppInstance[RAD-ApplicationName=HSS_SM],
   RAD-Vendor[RAD-VendorId=HSS_SM:10415]:RAD-TypeSize [[2], [1]] 
  TRIVIAL P  MERGE RAD-Application[applicationName=RADIUS],RAD-AppInstance[RAD-ApplicationName=HSS_SM],
   RAD-Vendor[RAD-VendorId=HSS_SM:10415]:RAD-VendorName [[3GPP]] 
  TRIVIAL PG ADD   RAD-Application[applicationName=RADIUS],RAD-AppInstance[RAD-ApplicationName=HSS_SM],
   RAD-Vendor[RAD-VendorId=HSS_SM:5535]
  ...
  ...

6. Click Done with Merge.

   The Merge is complete.

   Note:  

   PDB automatically generates an internal document number for the new configuration. This number can be modified by editing the configuration properties as described in Section 8.6.

   
   
7. If required, grant permission for other users to work with the new configuration by modifying the ACL. For more information on granting ACL permissions, refer to Section 3.1.1.

8.4   Creating a Delta Configuration

Delta configurations build upon and modify a parent configuration. The delta inherits all of its configuration data from the parent, except those elements that are locally overridden.

Delta configurations store only the changes that are made to the inherited data, including additions, deletions, and modifications. These updates supersede any corresponding elements that were inherited from the parent.

Any configuration can be used as the parent of a delta configuration, including another delta configuration.

PDB allows you to attach an existing delta configuration to a different parent configuration. This process is called Change Parent and is fully described in Section 8.4.1.

To create a delta configuration:

1. In the Configurations workspace, right-click a parent configuration for the new delta and select Create Delta.

   Note:  

   If the configuration is not displayed, perform a search as outlined in Section 8.1.1.

   
   

   The Delta dialog box opens. See Figure 41.

The following table describes the elements of the Delta dialog box:

2. Enter the required information. See Table 32.
3. Click Create.

   The delta configuration is created.

4. If required, grant permission for other users to work with the new configuration by modifying the ACL. For more information on granting ACL permissions, refer to Section 3.1.1.

8.4.1   Changing the Parent of a Delta Configuration

PDB can perform a Change Parent operation to attach an existing delta configuration to a different parent configuration. This new parent can be a newer revision of the same parent configuration or another configuration in PDB.

Change Parent maps configuration elements (in the delta) onto the new parent. If the structure of the parent configuration is different, this mapping will identify the reference points that correspond to the original configuration structure, where possible. For example, if a delta configuration adds a parameter to an inherited parameter group, Change Parent will attempt to locate the corresponding parameter group in the new parent configuration and update the delta references accordingly. For more information on Delta configurations, refer to Section 8.4.

Note:  

It is possible that the delta configuration will reference configuration elements that are no longer included in the parent. These elements are automatically removed during the Change Parent process. Any configuration elements that are removed in this way are documented in the Change Parent Configuration report.

8.4.1.1   Change to a New Revision of the Same Parent

To change the parent of a delta configuration to a new revision of the same configuration:

1. In the Configurations workspace, right-click a delta configuration and select Change Parent > Same Parent Different Revision.

   Note:  

   If the delta configuration is not displayed, perform a search as outlined in Section 8.1.1.

   
   

   The Change Parent dialog box opens. See Figure 42.

2. Select a new parent revision from the list.
3. Click Next.

   PDB analyzes the proposed change and updates the Change Parent dialog box with a summary of the configuration impacts. See Figure 43 for a sample summary.

   Note:  

   No changes are made to the configuration during this phase.

   
   

   If changing the parent configuration will force PDB to discard configuration items, a Change Parent Configuration report is generated to highlight the impacted configuration elements. In addition, any validation issues with the updated configuration are captured in a validation report.

4. If required, click Download Report to download the report files.

   The following example illustrates a sample Change Parent Configuration report. For a sample validation report, refer to Section 8.8.

REPORT - CHANGE PARENT CONFIGURATION

SOURCE CONFIGURATION : /HSS_11A_R9B_LDIF/HSS_11A_R9B_Lab2[PA1]
NEW PARENT CONFIGURATION : /HSS_11A_R9B_LDIF[PB1]

TARGET : /HSS_11A_R9B_LDIF/HSS_11A_R9B_Lab2[PA1]

33% parameter group instances ( 1 out of 3) will not be moved or copied 
33% parameter instances ( 2 out of 6) will not be moved or copied 

> Discarded PARAMETER-GROUP instances - Not defined in the schema of the new parent configuration: 
FTU[applicationName=FTU],tspFtuKeyReference[tspFtuKeyReferenceKey=0]

> Discarded PARAMETER instances - Not defined in the schema of the new parent configuration: 
FTU[applicationName=FTU],tspFtuKeyReference[tspFtuKeyReferenceKey=0],tspFtuKey=0
FTU[applicationName=FTU],tspFtuKeyReference[tspFtuKeyReferenceKey=0],tspFtuKey=2

5. Click Yes to perform the change parent operation.

8.4.1.2   Change to a Different Parent

To change the parent of a delta configuration to a different configuration:

1. In the Configurations workspace, right-click a delta configuration and select Change Parent > Different Parent.

   Note:  

   If the delta configuration is not displayed, perform a search as outlined in Section 8.1.1.

   
   

   The Change Parent dialog box opens. See Figure 44.

2. Using the Node and Revision lists as filters, select a new parent configuration.

   Note:  

   The New Parent Configuration field uses auto-complete functionality. Typing part of a name displays matching configurations for the selected node revision. Use the down-arrow on your keyboard to display all of the available configurations.

   
   
3. If required, select Keep a copy of the original delta configuration to preserve the original delta configuration.

   By default, Change Parent will modify the selected delta configuration to hang from a new parent without preserving the original configuration data. Keep a copy of the original delta configuration preserves the original data by creating a clone of the delta configuration that will hang from the new parent, leaving the selected delta configuration intact.

4. Click Next.

   PDB analyzes the proposed change and updates the Change Parent dialog box with a summary of the configuration impacts. See Figure 45 for a sample summary.

   Note:  

   No changes are made to the configuration during this phase.

   
   

   If changing the parent configuration will force PDB to discard configuration items, a Change Parent Configuration report is generated to highlight the impacted configuration elements. In addition, any validation issues with the updated configuration are captured in a validation report.

5. If required, click Download Report to download the report files.

   The following example illustrates a sample Change Parent Configuration report. For a sample validation report, refer to Section 8.8.

REPORT - CHANGE PARENT CONFIGURATION

SOURCE CONFIGURATION : /MPVL CSCF 13A Converged/Lab2[PA1]
NEW PARENT CONFIGURATION : /MPVL CSCF 14A Converged[F]

TARGET : /MPVL CSCF 14A Converged/Lab2[PA1]

66% parameter group instances ( 2 out of 3) will not be moved or copied 
40% parameter instances ( 4 out of 10) will not be moved or copied 

> Discarded PARAMETER-GROUP instances - Not defined in the schema of the new parent configuration: 
DIA-CFG-NeighbourNode-LocalVIPNetRed[localVIPNetRedNodeId=1]
DIA-CFG-OwnNode-LocalVIPNetRed[localVIPNetRedStackId=1]

> Discarded PARAMETER instances - Not defined in the schema of the new parent configuration: 
DIA-CFG-NeighbourNode-LocalVIPNetRed[localVIPNetRedNodeId=1],localVIPNetRedNodeId=1
DIA-CFG-NeighbourNode-LocalVIPNetRed[localVIPNetRedNodeId=1],connectFailureQuarantineTime=30
DIA-CFG-OwnNode-LocalVIPNetRed[localVIPNetRedStackId=1],localVIPNetRedStackId=1
DIA-CFG-OwnNode-LocalVIPNetRed[localVIPNetRedStackId=1],zone2TcpAddressList=127.0.0.1

6. Click Yes to perform the change parent operation.

8.5   Working with Configuration Revisions

Node configurations stored in PDB are revision controlled. A given revision will precede or supersede other revisions of the same configuration, allowing for a number of revision-specific operations.

These operations include:

• Changing the Document State
• Creating a New Revision
• Importing a New Revision

By default, only the latest revision of each configuration is displayed in the Configurations table. Older revisions are accessible through the revision history or by refining the search criteria. For more information on performing a search, refer to Section 8.1.1.

To view all revisions of a selected configuration, right-click to open the context menu and select Revision > Show Revision History.

PDB requires all predecessors to be in a locked state (FROZ, FREE, WIDR) before subsequent revisions can be created.

8.5.1   Document States

PDB uses a system of document states to provide information on the completeness, quality, and approval status of a particular configuration revision. The document state is indicated by a status code that is part of the configuration metadata. PDB uses the following document states for node configurations:

8.5.1.1   Changing the Document State

PDB allows you to change the document state of node configurations that you have permission to modify. For more information on ACL permissions, refer to Section 3.1.

Configuration revisions must follow the following sequence of document states:

PREL > FROZ > FREE > WIDR

Note:  

Only PDB System Administrators can set a configuration to a previous state.

New configurations, or configuration revisions start in the PREL state where they can be modified and updated. The document state is changed as the configuration progresses through its lifecycle.

To change the document state of a configuration revision:

1. In the Configurations workspace, right-click a configuration and select Revision > Set to <STATE>.

   Note:  

   If the configuration is not visible, perform a search as outlined in Section 8.1.1.

   
   

   When moving from PREL to FROZ, the Freeze dialog box opens. See Figure 46.

   Note:  

   Before a configuration can be frozen, the associated schema and IVL, if used, must also be frozen.

   
   

The Freeze dialog box allows you to modify the revision level of the configuration. Here preliminary revisions can be set to a solid state before freezing.

2. Click Freeze.

   The selected configuration is locked and the document state is set to FROZ.

For all other state transitions a confirmation dialog box is displayed.

Click OK to change the document state.

8.5.2   Creating A New Revision

You can update a locked configuration by creating a new revision. This process creates a clone of the locked configuration at a new revision level. The new revision retains the name and tags (IVL, IFN, MPVL, DPVL) associated with the original configuration and resets the document state to PREL, allowing you to modify the data.

To create a new revision of a frozen configuration:

1. In the Configurations workspace, right-click a locked configuration and select Revision > Create New Revision.

   Note:  

   If the configuration is not displayed, perform a search as outlined in Section 8.1.1.

   
   

   The New Revision dialog box opens with the next legal revision displayed. See Figure 47.

2. Verify that the proposed revision is correct and update as necessary.
3. Click Create New Revision.

   A new revision is created.

8.5.3   Importing a New Revision

A revised set of files can be imported to create a new revision of a locked configuration. The new revision retains the name and tags (IVL, IFN, MPVL, DPVL) associated with the original configuration and resets the document state to PREL, allowing you to modify the data.

Configuration files can be packaged in a ZIP or TAR archive, or imported directly from LDIF or XML files.

Note:  

An archive directory structure is not required by PDB to import configurations; however, if directories are present inside the file, then PDB will recursively scan for configuration files within the directories as needed.

To import a new revision of a configuration:

1. In the Configurations workspace, right-click a locked configuration and select Revision > Import New Revision.

   The Import New Revision dialog box opens with the next legal revision displayed. See Figure 48.

The following table describes the elements of the Import New Revision dialog box:

2. Enter the required information. See Table 33.
3. Click Import.

   PDB performs the following operations when importing a new configuration.

   1. PDB imports the data contained within the selected archive and generates a new configuration revision.
   2. PDB automatically performs a validation check during the import process. This check verifies the syntax of the configuration files and validates the configuration against the selected schema.
   3. PDB generates an import validation report that can be downloaded from the Report Available dialog box that appears at the end of the import process. For a description of the messages presented in import validation reports, refer to Configuration Validation Errors in the Appendix.
   4. PDB stores the configuration archive and the import validation report. These files can be downloaded from the properties dialog box for the new configuration.

8.6   Modifying Configuration Properties

While in PREL state, PDB allows you to modify the following configuration properties:

• Name
• Document number

  If no document number is specified, PDB automatically generates an internal number.

  Note:  

  Document numbers are validated using Ericsson's standard rules for registration notation.

  Subsequent revisions of an existing node configuration are locked to the document number of their predecessor.

  
  
• Description

  Note:  

  Subsequent revisions of an existing node configuration are locked to the description of their predecessor.

  
  
• Revision Comment
• Tag as an Initial Value List (IVL)

  Use the IVL tag to mark configurations that can act as an initial value list. For more information on the use of IVLs, refer to Section 8.9.

  Tagging a node configuration as IVL allows you to associate it with a configuration schema as an IVL. For more information on associating an IVL with a configuration schemas, refer to Section 7.4.1.

• Tag as Imported From Node (IFN)

  Use the IFN tag to mark configurations that have been imported from a node.

• Tag as Master Parameter Value List (MPVL)

  Use the MPVL tag to identify the official Master Parameter Value List for a specific node revision.

• Tag as Delta Parameter Value List (DPVL)

  Use the DPVL tag to mark delta configurations. For more information on delta configurations, refer to Section 8.4.

If the configuration is in a locked state, only the Description and Revision Comment fields can be modified.

Most configuration properties, including the tags, are visible in the Configurations table. To view all properties associated with a specific configuration, open the context menu for that configuration and select Properties.

To edit node configuration properties:

1. In the Configurations workspace, right-click an unlocked configuration and select Edit.

   Note:  

   If the configuration is not displayed, perform a search as outlined in Section 8.1.1.

   
   

   The Edit dialog box opens.

2. Update the configuration properties as required.
3. Click Apply.

   The updated properties are saved.

8.7   Migrating a Configuration to Another Schema

While in PREL state, PDB allows you to migrate a root configuration from one schema to another. This schema update can be performed between versions of the same schema or between different schemas.

Note:  

Because schemas outline the valid elements for a configuration, updating from one schema to another applies the requirements of the new schema to the existing data. This transition between schemas can invalidate parts of the configuration.

Before performing an update, PDB analyzes the proposed operation and generates a schema update report that documents all of the configuration elements that are structurally invalid under the new schema. Any parameters or parameter groups that do not fit within the new schema will be automatically removed during the migration process. The schema update report provides a detailed list of the configuration elements that must be removed during the procedure.

In addition to generating a schema update report, PDB performs a validation check on the remaining configuration elements to ensure that they are in line with the new schema definition. For more information on schema validation, refer to Section 8.8.

A schema update can only be applied to root configurations. Any child configurations are moved between the selected schemas simultaneously.

Note:  

The migration process requires a target schema. Ensure that the target schema exists in PDB before beginning this process. For more information on working with schemas, refer to Section 7.

To migrate a configuration:

1. In the Configurations workspace, right-click a root configuration in PREL state and select Update Schema. You cannot update the schema of a delta configuration since delta configurations must follow the schema used by the parent configuration.

   Note:  

   If the configuration is not displayed, perform a search as outlined in Section 8.1.1.

   
   

   The Schema Update dialog box opens. See Figure 49.

Note:  

Migrating a configuration changes the data structure. To preserve a copy of the original configuration tree, clone it prior to executing the migration procedure. For more information on cloning a configuration, refer to Section 8.3.2.

2. Select a target schema for the migration.

   Note:  

   By default, the list of schemas is filtered to display only the latest revisions. Clear Latest Schemas Only to display the complete list.

   
   
3. Click Next.

   PDB analyzes the proposed migration, updating the Schema Update dialog box with a summary of the configuration impacts and links to the schema update report and the validation report. See Figure 50 for a sample summary.

   Note:  

   No changes are made to the configuration(s) during this phase.

   
   

4. Click Schema Update Report or Validation Report to download the reports.

   The reports are pipe-separated text files that identify the impacted configuration elements. The following example illustrates a sample migration report. For a sample validation report, refer to Section 8.8.

Summary for Configuration: /MTAS_11A_R1D_LSV118_LDIF
Original Schema: MTAS_CM_MIM[PA1]
Target Schema: MTAS_CM_MIM[PA2]

Original Number of Parameter Groups: 1020
Original Number of Parameters: 4036
Parameter Groups to be Discarded: 1
Parameters to be Discarded: 20

Details:

PG | tspPmApplication[applicationName=tspPM]
P  | tspPmApplication[applicationName=tspPM],tspPmEnable-TRUE
P  | tspPmApplication[applicationName=tspPM],tspPmMaxMonitorNr=300
P  | tspPmApplication[applicationName=tspPM],tspPmmaxMeasReaderNr=3000
P  | tspPmApplication[applicationName=tspPM],tspPmMaxPmdbMemorySize=16
P  | tspPmApplication[applicationName=tspPM],tspPmMonitorNr=38
P  | tspPmApplication[applicationName=tspPM],tspPmMeasReaderNr=668
P  | tspPmApplication[applicationName=tspPM],tspPmTimeZone=local
P  | tspPmApplication[applicationName=tspPM],tspPmMaxPmdbCpuLoad=1.000000
P  | tspPmApplication[applicationName=tspPM],tspPmMaxAlarmPerMeasType=10
...

5. Click Finish to migrate the configuration.

8.8   Validating a Configuration

PDB can validate node configurations to ensure they conform to their respective schema definitions. A validation check is performed automatically as part of the following operations, but should be triggered manually, as needed:

• Importing Configurations
• Migrating Configurations to Another Schema
• Modifying Configuration Data (PDB validates changes to the configuration data on-the-fly)
• Rebasing Delta Configurations

Triggering a manual validation check through the PDB GUI is strongly recommended after any operation that impacts the configuration data and prior to export.

PDB performs the following checks during schema validation:

Issues discovered during the validation check are output to a plain text file that can be downloaded from the PDB server. The report displays the following messages:

To validate a configuration:

1. In the Configurations workspace, right-click a configuration and select Validate.

   Note:  

   If the configuration is not displayed, perform a search as outlined in Section 8.1.1.

   
   

   The Validation dialog box opens. See Figure 51.

2. If required, select an available site-specific list to resolve parameter value variables in the selected node configuration.

   Note:  

   The Site Specific List field uses auto-complete functionality. Typing part of a name displays matching site-specific lists. Use the down-arrow on your keyboard to display all of the available lists.

   By default, PDB only shows site-specific lists that are associated with this configuration. Select Show All Site-Specific Lists to see all available lists.

   
   
3. Click Validate.

   The node configuration is validated against the associated schema.

   If validation issues are found, the Report Available dialog box opens.

4. Click Download Report to save the Validation report.

Example 6 presents a sample validation report.

CONFIGURATION VALIDATION REPORT
Configuration: /CSCF_11B_R4G_LDIF[PB1]
Schema: CSCF_CM_MIM[A]

WARNING CARDINALITY | PG | SigCompAdvertisedState | Actual cardinality: 0 | Schema constraints: 1-1
WARNING CARDINALITY | PG | SigCompNonTrafficTrace | Actual cardinality: 0 | Schema constraints: 1-1
WARNING CARDINALITY | PG | SigCompProfileContainer | Actual cardinality: 0 | Schema constraints: 1-1
WARNING CARDINALITY | PG | SigCompTrace | Actual cardinality: 0 | Schema constraints: 1-1
WARNING CARDINALITY | PG | SigCompProfile | Actual cardinality: 0 | Schema constraints: 1-1
WARNING       VALUE | P  | tspPmApplication[applicationName=tspPM],tspPmMeasReaderNr=0 |
   Data type: NUMERIC_BIG_DECIMAL | Format: Greater or Equal to: 1 / Less or Equal to: 5000
WARNING       VALUE | P  | tspPmApplication[applicationName=tspPM],tspPmMonitorNr=0 |
    Data type: NUMERIC_BIG_DECIMAL | Format: Greater or Equal to: 1 / Less or Equal to: 500
WARNING       VALUE | P  | DNS-Application[applicationName=DNS],DnsServerEntry=10.80.52.34:53 |
    Data type: STRING | Format: Pattern: ([0-9]{1,3}\.){4}:[0-9]+
INFO         UNUSED | PG | tspPmApplication[applicationName=tspPM],tspPmMonitorGroup
INFO         UNUSED | PG | tspLicenseManagement[applicationName=tspLicenseManagement],
   tspLicenseServerConnection
INFO         UNUSED | PG | NumberNormalisation[applicationName=NumberNormalisation],
   NumNormProfile[NumNormProfile=0],NumNormNsnData
INFO         UNUSED | PG | NumberNormalisation[applicationName=NumberNormalisation],
   NumNormProfile[NumNormProfile=0],NumNormOsnData
INFO         UNUSED | PG | NumberNormalisation[applicationName=NumberNormalisation],
   NumNormProfile[NumNormProfile=0],NumNormDenormalizationSubstitutionRule
...
...
...

8.9   Exporting a Node Configuration

PDB exports node configurations as ZIP or TAR files. With the exception of configurations exported in the PVL format, all exported configurations contain the necessary logic to actually configure the target node.

PDB supports the use of Initial Value Lists (IVLs) that can be associated with configuration schemas. IVLs represent the configuration of an LDAP node after maiden installation. When exporting a node configuration in LDIF format, PDB will use IVL data associated with the configuration schema to produce configuration files that do not collide with the configuration values that are assumed to already exist in the real node. For more information on linking an IVL to a schema, refer to Section 7.4.1.

Before exporting a configuration in EAS, LDIF, or NETCONF format, PDB must resolve all of the site-specific variables that have been defined in the configuration data. These variables can resolved manually or through the use of a site-specific list.

• For more information on site-specific variables, refer to Section 9.3.4.
• For more information on site-specific lists, refer to Section 13.

In addition to any site-specific variables present in a node configuration, PDB must resolve values for several mandatory Configuration Management (CM) variables that are used to set up the configuration tool itself. For more information on CM variables refer to Section 18.

Exporting node configurations can be triggered through web services or using the GUI or CLI.

8.9.1   Web Services Export

When a web service export is initiated, a web client requests a specific configuration and provides the required site-specific values to PDB. After processing the request, PDB returns a configuration ZIP file to the web client for use in configuring the node.

In the IMSREF System Tool, the RIOT component is configured as a PDB web client.

Note:  

Alignment between the site-specific parameters defined in PDB and the parameter mapping within RIOT is required to perform a successful web services export. For more information on the RIOT parameter mapping, refer to Mapping Parameters in the RIOT Provisioning and Configuration section of the IMSREF Reusable Inter-Operability Testing (RIOT) System Administration Guide, 1/1543-CXP 902 0096.

8.9.2   Exporting a Configuration from the PDB GUI

PDB allows you to export node configurations through the GUI or the CLI. This section describes the export procedure using the GUI. For information on exporting node configurations using the PDB CLI, refer to export-configuration in the PDB Command Line Interface (CLI) Reference, 1/1540-CXP 902 0212.

Before a configuration can be exported in LDIF, NETCONF or PED (EAS) format, all of the required site-specific values must be populated. Values for individual site-specific parameters can be input during the export procedure or resolved using a site-specific list. For more information on site-specific lists, refer to Section 13.

Note:  

Exporting a configuration in PVL format does not require any site-specific information. This format is used to preserve configuration data along with any parameter value variables.

Using PDB, you can export the following configuration types:

• Full Configurations

  Exporting a full configuration includes the entire configuration tree. All parameter groups and parameters associated with the selected configuration, either directly or through inheritance, are included. Full configurations can be used to completely replace any configuration data currently installed on the selected node.

• Delta Configurations

  Exporting a configuration delta includes only the parameter groups and parameters that are local to the delta configuration. Any data inherited from parent configurations are not included. While delta configurations are not structurally valid on their own, they can be used, for example, to directly upgrade a node from one configuration to another by capturing the differences between them or to set a specific feature on/off. For more information on generating a delta configuration from comparison results, refer to Section 10.3.

To manually export a node configuration:

1. In the Configurations workspace, right-click a configuration and select Export.

   Note:  

   If the configuration is not displayed, perform a search as outlined in Section 8.1.1.

   
   

   The Export dialog box opens.

The following table describes the elements of the Export dialog box:

2. Enter the required information. See Table 34.
3. Click Export.

   When exporting a node configuration, PDB follows a set of business rules that govern the format and structure of the configuration data. For more information on the PDB export criteria, refer to Section 15.

   The configuration is exported in the selected format. When PDB has finished processing the data, a link to the exported configuration is displayed.

4. Click Download Configuration to save the configuration archive.

8.9.2.1   Exporting a Configuration Report

Using PDB, you can export configuration data to a CSV file. This format can be post-processed to produce readable reports that detail the configuration. The exported CSV file combines information from the node configuration and the configuration schema to provide context and a better understanding of each parameter and parameter group.

A CSV report includes the following information:

• Node Name
• Configuration Name
• Configuration Document Number
• Configuration Revision
• Element Type
• MOC
• MOI
• Element Name
• Configured Value
• Default Value
• Parameter Type
• Element Description

  Note:  

  From the configuration schema.

  
  
• Comment

To generate a configuration report, export a configuration as outlined in Section 8.9.2 and select CSV (report) as the export format.

8.9.3   Deploying and Executing a Node Configuration

Configurations exported in EAS, LDIF, or NETCONF format can be used to configure nodes directly.

Node configurations are exported in a compressed TAR or ZIP format. Each archive contains the run_configure script and the node configuration data.

Note:  

When deploying a configuration using a NETCONF format, Windows users must run the run_configure.bat script instead of the run_configure.sh.

To configure a node using a configuration bundle exported from PDB:

1. Deploy the configuration ZIP or TAR file where applicable.
2. Extract the archive within an empty transition directory.
3. If required, set permissions for run_configure.sh so that it can be executed in Linux.

   chmod 777 run_configure.sh

4. Run the script.

   During execution, run_configure produces a log file called log.<pid> in the local directory that contains all of the information displayed in the console.

The following example shows one possible command sequence for executing the configuration script in Linux.

mkdir -p /tmp/pdbconfigtool
cd /tmp/pdbconfigtool
(deploy configuration bundle here)
unzip config-MPVL_CSCF_13A_FIXED-20130117_153648.zip
chmod 777 run_configure.sh
./run_configure.sh

8.9.4   Working With Dependencies on LDAP Configurations

In addition to the dependencies defined at configuration schema level, dependencies can also be associated with LDAP configurations to guide provisioning. When a configuration element has dependencies, the value of a second configuration element must be set to a specific value before or after configuring the original element.

For example, parameter A cannot be defined unless parameter B is set to 0. After parameter A has been set, parameter B must be set back to 1.

PDB uses the ellsh tool to configure nodes using LDAP. ellsh handls the following dependency scenarios:

For more information on the syntax of LDAP dependencies, refer to the ellsh 1.2 User Guide, 198 17-CXP 902 0245.

PDB is pre-provisioned with several common dependencies (such as: DIAMETER stack dependencies, administrative states of some IMS nodes, and so on.); however, the pre-provisioned list does not cover all of the possible dependencies. PDB administrators can add new dependency statements or override existing ones by making modifications to the dependencies file.

Note:  

PDB end users must contact an administrator to add, modify, or delete parameter dependencies.

To modify the dependencies file:

1. Use SSH to log in to the PDB server as glassfish.
2. Navigate to the file location:

   cd /usr/local/glassfish/domains/domain1/config/pdb/scripts/

3. Make a backup copy of the dependencies file:

   cp dependencies <backup file name>

4. Open the dependencies file for editing:

   vi dependencies

   Example 8 shows sample statements from the dependencies file.

...
pre  ^[EPSI]cscfNetworkInterfaceEntry=(UDP|TCP):
     \d{1,3}(\.\d{1,3}){3}:(\d{4,5}),
     [EPSI]cscfNwIfContainerKey=0,CscfNwIfContainerKey=0,  
     applicationName=CSCF,nodeName=\w+$   
     applicationName=CSCF,nodeName=nodeName  
     CscfAdministrativeState 0  
post  ^[EPSI]cscfNetworkInterfaceEntry=(UDP|TCP):
     \d{1,3}(\.\d{1,3}){3}:(\d{4,5}),
     [EPSI]cscfNwIfContainerKey=0,CscfNwIfContainerKey=0, 
     applicationName=CSCF,nodeName=\w+$  
     applicationName=CSCF,nodeName=nodeName  
     CscfAdministrativeState 1  
pre  EcscfKey=0,applicationName=CSCF,nodeName=jambala  
     applicationName=CSCF,nodeName=nodeName  
     CscfAdministrativeState 0  
post EcscfKey=0,applicationName=CSCF,nodeName=jambala  
     applicationName=CSCF,nodeName=nodeName  
     CscfAdministrativeState 1 
...

Note:  

Each pre/post entry represents one line in the dependencies file.

5. Update the pre, post, and toggle operations as required.

   For more information on the syntax of LDAP dependencies, refer to the ellsh 1.2 User Guide, 198 17-CXP 902 0245.

6. Exit vi, saving your changes:

   :wq!

When PDB exports a configuration in LDIF format, it looks for the dependencies file to include in the configuration bundle under /usr/local/glassfish/domains/domain1/config/pdb/scripts/. If the dependencies file exists, PDB uses it to produce the configuration ZIP file. If the file does not exist, PDB uses the built-in dependencies file.

8.10   Deleting a Node Configuration

Authorized users can remove node configurations from PDB as needed.

Note:  

PDB cannot remove configurations in a locked state, parent configurations, a configuration that has been associated with node revisions, or any configuration that is part of a configuration set. In these cases, you must ensure that the configuration is no longer being referenced within PDB before attempting to delete it.

To delete a configuration:

1. In the Configurations workspace, right-click a configuration and select Delete.

   Note:  

   If the configuration is not displayed, perform a search as outlined in Section 8.1.1.

   
   

   A confirmation dialog box opens.

   Caution!

   Deleting a configuration permanently removes it from PDB.

2. Click OK.

   The configuration is deleted.

9   Working with Configuration Data

Node configurations contain a collection of parameters and parameter groups that are used to configure the software on a node. These parameters and parameter groups (collectively called configuration data) are structured in accordance with a configuration schema that defines all of the legitimate classes and attributes for a specific node revision. For more information on configuration schemas, refer to Section 7.

PDB provides a dedicated workspace for configuration data. The configuration browser is described in Section 9.1.

Managing configuration data involves making modifications to parameters and parameter groups, such as:

• Adding a Parameter Group
• Commenting a Parameter Group
• Deleting a Parameter Group
• Adding a Parameter
• Modifying a Parameter
• Deleting a Parameter

PDB supports the following node configurations:

9.1   The Configuration Browser

The configuration browser is the primary way for users to manage configuration data in PDB.

Configuration data can be displayed in two possible formats:

• TREE view (Default)
• TABLE view

In the TREE view, PDB displays configuration data as a cascading tree of parameter groups, each group containing one or more parameters. In this view, information is divided between two frames.

The left frame shows a compressed list of parameter groups along with any parameter structs in those groups. The right frame displays the parameters or struct members contained within a selected parameter group or parameter struct. Selecting a configuration element in the left frame will display its contents in the right frame.

Parameters or struct members are presented in a table with the following information:

• Name
• Value
• Comment

See Figure 52.

In the TABLE view, PDB displays configuration data as a table of nested parameter groups, each containing one or more parameters. The table includes the following information, where applicable:

• MOI

  The Managed Object Instance (MOI) shows the path of the configuration element in the configuration tree.

  Note:  

  Only the last section of the MOI is shown in table view. The full path of the configuration element is available as a tooltip.

  
  
• Name
• Value
• Comment

See Figure 53.

To switch between TREE and TABLE views, make a selection from the Format drop-down list at the top of the page. Selected elements are not affected by switching between views.

When working with configuration data, colors are used to provide extra information about the configuration elements as follows:

To browse a configuration in PDB:

• In the Configurations workspace, select a configuration to browse and click Open.

  Note:  

  If the configuration is not displayed, perform a search as outlined in Section 8.1.1.

  
  

  Elements of the selected configuration are displayed in the configuration browser.

  To facilitate working with large configurations, the configuration browser includes a search functionality that allows you to filter the displayed list of configuration elements. For more information on the search functionality, refer to Section 9.1.1.

The following table describes the elements of the configuration browser:

The configuration browser uses contextual menus to work with parameters and parameter groups. Simply right-click a configuration element to access the available operations. These operations include:

9.1.1   Searching Node Configurations

The configuration browser includes a search functionality that locates specific configuration elements using a number of different criteria.

The search field accepts keywords to narrow down the search results. The syntax for using keywords is as follows:

<keyword1>:value1 <keyword2>:value2 <keyword3>:value3 ...

The following table describes the available keywords.

To perform a search:

1. In the configuration browser, click Search.

   The Search dialog box is displayed. See Figure 54.

2. Enter your search query.

   For a basic search, type the name or value of the configuration element you are searching for.

   Note:  

   Search strings are not case-sensitive. All searches return a partial match unless the string is surrounded by double quotes.

   
   

   For a keyword search, compose a search string using one or more valid keywords. See Table 37 for a description of the available search options.

   Note:  

   Different keywords can be combined to refine the search pattern.

   Some sample search queries, include:

   • name: tspPmEnable type:P

     This query would search for parameters named tspPmEnable.

   • type:PG status:obsolete

     This query would search for parameter groups that are currently set as obsolete.

   • comment: for performance management

     This query would search for parameters or parameter groups that contain a for performance management comment.

   • moi:tspPmApplication[applicationName=tspPM] type:P

     This query would search for parameters located at the specified location in the configuration tree.

   
   
3. Click Search.

   The search hits are listed in the table at the bottom of the Search dialog box. See Figure 55.

   Note:  

   If you have enabled Show Unused in the configuration browser, unused configuration elements will be included in the search results.

   
   

   Search results are listed with the following information, where applicable:

   • Parameter Name
   • Value
   • MOC
   • MOI

4. Click the magnifying glass () next to one of the search results to open the configuration tree at that element's location.

   The search is complete.

   Search results are available in CSV format. Click Export to CSV to download the CSV file.

9.1.1.1   Bulk Operations

When working with an unlocked configuration, the configuration browser allows you to perform bulk operations on search results. Using bulk operations, you can edit or delete multiple parameter instances simultaneously.

Bulk Replacement

To perform bulk replacement of parameter values:

1. Perform a search for the required parameters as described in Section 9.1.1.

   The search results are listed.

2. Using the check boxes, select the parameters to update.

   Note:  

   PDB does not allow you to perform bulk operations on parameter groups. No check box is available for these configuration elements.

   
   
3. Click Replace.

   The Bulk Operations area is displayed. See Figure 56.

The following table describes the elements of the Bulk Operations area:

(1)  Only available when a regular expression has been used for the replacement pattern.

4. Enter the required information. See Table 38.
5. If required, click Preview to see your changes reflected in the table of search results.

   Note:  

   The preview operation does not modify configuration data.

   
   
6. Click Apply.

   All pattern matches are replaced with the selected value.

   By default, PDB automatically performs a validation check when modifying parameters and displays the results, if applicable. The check verifies that the bulk replacement is in line with the schema definition for this configuration. For a description of the validation check, refer to Section 8.8.

   Note:  

   PDB tracks parameter modifications across configuration revisions. Changes to the parameter value are captured in the Parameter Value History.

   To view the history of a parameter, select it in the configuration browser and click History.

   
   

Bulk Delete

Deleting inherited elements does not remove them from the parent configuration. When an inherited element is removed from a delta configuration, it is replaced with a deleted data reference that is accessible at the corresponding location in the Delta Only view. This data reference can be restored to bring back the inherited data.

If a configuration has inherited several instances of a given parameter type, all instances can be blocked at the same time using Block All.

To perform a bulk delete of configuration parameters:

1. Perform a search for the required parameters as described in Section 9.1.1.

   The search results are listed.

2. Using the check boxes, select the parameters to delete.

   Note:  

   PDB does not allow you to perform bulk operations on parameter groups. No check box is available for these configuration elements.

   
   
3. Click Delete.

   Note:  

   Primary key parameters cannot be deleted in this way. To remove a primary key parameter, you must delete the associated parameter group. For more information on deleting parameter groups, refer to Section 9.2.4.

   
   

   A confirmation dialog box opens.

4. Click Apply.

   The selected parameters are deleted.

9.2   Working With Parameter Groups

Within the constraints of the schema, you can add or remove parameter groups and provide descriptive comments.

9.2.1   Adding Parameter Groups

The configuration browser can be used to add new parameter groups to the local configuration.

To add a new parameter group:

1. In the configuration browser, right-click a parent for the new parameter group and select Add Parameter Group.

   If needed, you can perform a search as described in Section 9.1.1.

   The Add Parameter Group dialog box opens. See Figure 57.

The following table describes the elements of the Add Parameter Group dialog box:

2. Enter the required information. See Table 39.
3. Click Apply.

   The parameter group is added to the local configuration.

   By default, PDB automatically performs a validation check when adding parameter groups and displays the results, if applicable. The check verifies that the new addition is in line with the schema definition for this configuration. For a description of the validation check, refer to Section 8.8.

9.2.2   Copying and Pasting a Parameter Group

The configuration browser can be used to copy a parameter group and paste it within the same configuration.

Copying a parameter group captures all configuration elements within the selected group, including subgroups and parameters.

To copy and paste a parameter group:

1. In the configuration browser, right-click a parameter group and select Copy.

   If needed, you can perform a search as described in Section 9.1.1.

   Note:  

   Root elements and singletons cannot be copied.

   
   

   The parameter group is copied.

2. Navigate the configuration and select a location to paste the parameter group.

   If needed, you can perform a search as described in Section 9.1.1.

   Note:  

   The configuration schema must allow the copied parameter group to be inserted at the selected location.

   
   
3. Right-click the selected location and select Paste.

   The Copy/Paste Parameter Group dialog box opens. See Figure 58.

The following table describes the elements of the Copy/Paste Parameter Group dialog box:

4. Enter the required information. See Table 40.
5. Click Apply.

   The copied parameter group is pasted under the selected location.

   By default, PDB automatically performs a validation check when pasting parameter groups and displays the results, if applicable. The check verifies that the new addition is in line with the schema definition for this configuration. For a description of the validation check, refer to Section 8.8.

9.2.3   Commenting a Parameter Group

The configuration browser can be used to add, modify, or remove descriptive comments for parameter groups in the local configuration.

To comment on a parameter group:

1. In the configuration browser, right-click a parameter group to comment and select Edit.

   If needed, you can perform a search as described in Section 9.1.1.

   The Edit dialog box opens. See Figure 59.

2. Add, modify, or remove your comment in the Comment field.
3. Click Apply.

   The parameter group is updated.

9.2.4   Deleting a Parameter Group

Authorized users can remove parameter groups from a configuration.

Deleting inherited elements does not remove them from the parent configuration. When an inherited element is removed from a delta configuration, it is replaced with a deleted data reference that is accessible at the corresponding location in the Delta Only view. This data reference can be restored to bring back the inherited data.

To delete a parameter group from the local configuration:

1. In the configuration browser, right-click a parameter group to remove and select Delete.

   If needed, you can perform a search as described in Section 9.1.1.

   A confirmation dialog box opens.

   Caution!

   Deleting a parameter group also removes all child parameter groups and any associated parameters.

2. Click OK.

   The selected parameter group is removed from the local configuration.

9.3   Working with Parameters

Within the constraints of the schema, you can add, modify, or remove configuration parameters and parameter structs.

9.3.1   Adding Parameters

The configuration browser can be used to add new parameters to the local configuration. Parameters can be added using the Add Parameter dialog box, described here, or directly in the configuration browser using in-line editing. For more information on using in-line editing to add new parameters, refer to Section 9.3.1.1.

To add a new parameter using the Add Parameter dialog box:

1. In the configuration browser, right-click a parameter group that will contain the new parameter and select Add Parameter.

   If needed, you can perform a search as described in Section 9.1.1.

   The Add Parameter dialog box opens. See Figure 60.

The following table describes the different elements forming the Add Parameter dialog box:

2. Enter the required information. See Table 41.
3. Click Apply.

   The parameter is added to the local configuration.

   By default, PDB automatically performs a validation check when adding parameters and displays the results, if applicable. The check verifies that the new addition is in line with the schema definition for this configuration. For a description of the validation check, refer to Section 8.8.

   If this parameter has been populated with a parameter value variable, the validation check will verify that the variable is included on the Global Variables list. PDB warns if the variable is not defined in the global list, but does not prevent the use of custom variables.

9.3.1.1   Adding Parameters Using In-Line Editing

The PDB configuration browser allows you to add parameters directly to a configuration using in-line editing. This process makes it easier to work with multiple parameters at the same time, allowing you to make additions in a single step.

Note:  

In-line editing can only add unused parameters to a node configuration.

To add parameters using in-line editing:

1. In the configuration browser, select the following options:
   • Enable TREE view (default) by selecting TREE from the format list.
   • Enable the display of unused configuration elements by selecting the Show Unused check box.

   For more information on these configuration browser options, refer to Section 9.1.

2. Navigate to a parameter group containing the unused parameters that you want to add.

   If needed, you can perform a search as described in Section 9.1.1.

   The list of parameters is displayed in the right frame. See Figure 61.

   Note:  

   Unused parameters that are not instantiated in the current configuration are colored purple and are commented with Not present. Existing parameters can be modified while adding new elements. For more information on modifying parameters using in-line editing, refer to Section 9.3.3.1.

   
   

3. Click Edit In-Line at the top of the parameters table or right-click a parameter and select Edit In-Line.

   The parameters table opens in edit mode. See Figure 62.

4. For each unused parameter, enter the required information and select the Create check box.

   If an usused parameter has a default value, the default will be set as the initial value.

   For more information on the parameter fields, refer to Section 9.3.1.

   Note:  

   Unused parameters can only be added to a parameter group that is part of the node configuration. If the selected parameter group is also unused, the corresponding primary key will be automatically selected for addition.

   
   
5. Click Apply.

   The new parameters are added to the node configuration.

9.3.2   Adding Parameter Structs

Where permitted by the configuration schema, parameter structs can be added to the local configuration. The configuration browser treats parameter structs in the same way as parameter groups. In TREE view, a parameter struct is added in the left frame, along with parameter groups, and the associated struct members are modified in the right frame.

To add a new parameter struct:

1. In the configuration browser, right-click a parameter group that will contain the new parameter struct and select Add Parameter Struct.

   If needed, you can perform a search as described in Section 9.1.1.

   The Add Parameter Struct dialog box opens. See Figure 63.

The following table describes the different elements forming the Add Parameter Struct dialog box:

2. Enter the required information. See Table 42.
3. Click Apply.

   The parameter struct is added to the local configuration.

   By default, PDB automatically performs a validation check when adding parameter structs and displays the results, if applicable. The check verifies that the new addition is in line with the schema definition for this configuration. For a description of the validation check, refer to Section 8.8.

9.3.3   Modifying Parameters or Parameter Structs

The properties of an existing parameter or parameter struct can be modified. In addition to these changes, PDB also allows you to edit Primary Key parameters that are local to the configuration.

Note:  

Modifying a Primary Key changes the DN of the associated parameter group.

Any Primary Key parameters that are inherited from the parent configuration cannot be modified in a delta configuration.

Parameters and struct members can be modified through the Edit dialog box, described here, or directly in the configuration browser using in-line editing. For more information on using in-line editing to modify parameters or struct members, refer to Section 9.3.3.1.

To update a parameter or parameter struct using the Edit dialog box:

1. In the configuration browser, right-click a configuration element to modify and select Edit.

   If needed, you can perform a search as described in Section 9.1.1.

   The Edit dialog box opens. See Figure 64.

The following table describes the elements of the Edit dialog box:

2. Update the Value or Comment fields, as required.
3. Apply your changes.

   The configuration element is updated. If required you can move directly to an adjacent parameter or parameter struct instance using the navigation buttons.

   By default, PDB automatically performs a validation check when modifying a configuration element and displays the results, if applicable. The check verifies that your change is in line with the schema definition for this configuration. For a description of the validation check, refer to Section 8.8.

   If this edit has populated a parameter with a parameter value variable, the validation check will verify that the variable is included on the Global Variables list. PDB warns if the variable is not defined in the global list, but does not prevent the use of custom variables.

   Note:  

   PDB tracks modifications to parameters and parameter structs across configuration revisions. Value changes are captured in the Parameter Value History.

   To view the history of a parameter or parameter struct, select it in the configuration browser and click History.

   
   

9.3.3.1   Modifying Parameters and Struct Members Using In-Line Editing

The PDB configuration browser allows you to modify parameters or struct members using in-line editing. This process makes it easier to work with multiple values at the same time, allowing you to several changes in a single step.

To modify parameters or struct members using in-line editing:

1. In the configuration browser, enable TREE view (default) by selecting TREE from the format list.

   For more information on configuration browser options, refer to Section 9.1.

2. Select a parameter group or parameter struct containing the configuration elements that you want to modify.

   If needed, you can perform a search as described in Section 9.1.1.

   A list of parameters or struct members is displayed in the right frame. See Figure 65.

   Note:  

   Unused parameters that are not instantiated in the current configuration are colored purple and are commented with Not present. These parameters can be added to the configuration while modifying other elements. For more information on adding unused parameters using in-line editing, refer to Section 9.3.1.1.

   
   

3. Click Edit In-Line at the top of the table or right-click a configuration element and select Edit In-Line.

   The parameters table opens in edit mode. See Figure 66.

4. For each parameter or struct member, enter the required information.

   For more information on the parameter fields, refer to Section 9.3.3.

5. Click Apply.

   The updated configuration elements are added to the node configuration.

9.3.4   Site-Specific Variables

Node configurations can include a number of site-specific parameters that define parts of the target network environment, such as IP addresses, port numbers, domain names, and login credentials, that cannot be known in advance. To facilitate working with site-specific information, PDB allows you to populate these values with parameter value variables.

Site-specific variables act as a place holder for legitimate values. When exporting a node configuration in EAS, LDIF, or NETCONF format, these variables must be resolved manually or through the use of a site-specific list.

• For more information on exporting node configurations, refer to Section 8.9.
• For more information on site-specific lists, refer to Section 13.

Using variables to populate the site-specific parameters inside a node configuration allows it to function independently of site-specific information.

PDB identifies a parameter value variable as a string defined between double curly brackets {{ and }} that uses the following supported characters:

• alpha-numeric (a,A, to z,Z and 0-9)
• underscore ( _ )
• dash ( - )

For example, the string {{server_abc_ip_address}} is considered to be a site-specific variable called server_abc_ip_address.

PDB does not support nested site-specific variables, such as {{somename@{{domain}}}}.

PDB includes a global list of parameter value variables. This list allows authorized users to define a set of variables that are recommended for use in PDB. Global variables can be added to a node configuration using auto-complete functionality.

Variables are defined for site-specific parameters in the same way as regular values. For more information, refer to the previous sections.

9.3.5   Deleting Parameters or Parameter Structs

Authorized users can remove parameters or parameter structs from a configuration.

Note:  

Individual struct members and primary key parameters cannot be deleted in this way.

To remove a primary key parameter, you must delete the associated parameter group. For more information on deleting parameter groups, refer to Section 9.2.4.

To remove a struct member, the entire parameter struct must be deleted.

Deleting inherited elements does not remove them from the parent configuration. When an inherited element is removed from a delta configuration, it is replaced with a deleted data reference that is accessible at the corresponding location in the Delta Only view. This data reference can be restored to bring back the inherited data.

If a configuration has inherited several instances of a given parameter type, all instances can be blocked at the same time using Block All.

To delete a parameter or parameter struct from the local configuration:

1. In the configuration browser, right-click a parameter or parameter struct to remove and select Delete.

   If needed, you can perform a search as described in Section 9.1.1.

   A confirmation dialog box opens.

2. Click OK.

   The selected parameter or parameter struct is removed from the local configuration.

10   Comparing Two Configurations

Using PDB you can compare the contents of two node configurations to identify the differences between them. Both parameters and parameter groups are analyzed in a comparison and any difference in value is identified.

When performing a comparison, PDB distinguishes between an Original Configuration and a Target Configuration. The Original Configuration serves as a starting point for the comparison. Data from the Original Configuration is compared against a Target Configuration. Both the Original Configuration and the Target Configuration can be defined within PDB, or uploaded specifically for comparison purposes. A comparison of uploaded configurations is performed on the fly, without creating persistent data in PDB. Performing a comparison on the fly can be useful when comparing the configuration of two live nodes or comparing a real configuration against a reference configuration defined in PDB.

Comparison results are output to a table on screen. The Configuration Comparison Report is a customizable printout of the differences between the Original and the Target configurations. For more information on the comparison options, refer to Section 10.1.1.

Comparison results can be used to generate a new delta configuration that hangs from the Original Configuration. This delta contains only the differences between the Original and Target configurations. When combined, data from the delta configuration and the Original Configuration is identical to the Target Configuration. For more information on generating a delta configuration from comparison results, refer to Section 10.3.

The Configuration Comparison Report can be downloaded as a Comma Separated Values (CSV) file.

10.1   The Configuration Comparison Workspace

The Configuration Comparison workspace allows you to compare node configurations.

To access the Configuration Comparison workspace, select Comparison from the menu options on the left. See Figure 67.

The workspace is divided into three areas as follows:

Note:  

The Comparison Options and Manage Columns areas are collapsed by default. These areas can be expanded with a mouse click.

10.1.1   Customizing Comparison Results

The PDB comparison tool includes a set of options to customize the comparison report. These options help to restrict the overall number of differences identified in the report.

In addition to options that modify the report data, PDB allows you to control which columns are displayed in the comparison report. For more information on managing columns in the comparison report, see Section 10.1.1.1.

To set the comparison options:

1. In the Configuration Comparison workspace, click Comparison Options.

   The comparison options are displayed, see Figure 68.

The following table describes the different comparison options: