User Guide for Resource Activation
Ericsson Dynamic Activation 1

Contents

1Introduction
1.1Purpose and Scope
1.2Target Group
1.3Typographic Conventions
1.4Prerequisites

2

General
2.1Logging in
2.1.1Logging in Using Internal Authentication
2.1.2Logging in Using External Authentication
2.2Launchpad
2.3Slide-in Navigation Column
2.4User Profile
2.5Resilient Activation Configuration

3

Asynchronous Control
3.1Configure Functions

4

CAI3G DC
4.1Create CAI3G DC Routing
4.2Edit CAI3G DC Routing
4.3Delete CAI3G DC Routing

5

Cluster Strategies
5.1Create Cluster Strategy Instance
5.1.1Parameters
5.2Edit Cluster Strategy Instance
5.3Delete Cluster Strategy Instance

6

MO Type and NE Type Mapping
6.1Mapping and Unmapping in Southbound MO Types List
6.2Mapping and Unmapping in Graph

7

Notification Rule Configuration
7.1Configure Notifications

8

Management
8.1General
8.1.1GUI Overview
8.1.2GUI Icons
8.2Activation Logic Control
8.2.1Activation Logic
8.2.2Options
8.3Network Elements Control
8.3.1Network Elements
8.3.2Network Element Groups
8.3.3Routing
8.4System
8.4.1Licenses
8.4.2Options
8.4.3Notification Email Configuration
8.4.4Synchronize Configuration
8.5Access Control
8.5.1Users
8.5.2Policies
8.5.3Attribute Rules - Restriction Rules
8.5.4Administration Domains
8.6Walkthroughs Control
8.6.1Initial Setup

9

Priority Configuration
9.1Add or Edit a Priority Rule
9.2Delete a Priority Rule

10

Retry Rule Configuration
10.1Create Retry Rule
10.2Manage Retry Rules
10.2.1View Retry Rule Details
10.2.2Change Retry Rule Priority
10.2.3Edit Retry Rule
10.2.4Copy Retry Rule
10.2.5Delete Retry Rule

11

Asynchronous Request Management
11.1Search by Condition
11.2View Details of the Search Result
11.3Delete Pending Items
11.3.1Result of Delete Operation

12

Request Management
12.1Search in Request Queues
12.2Monitor and Manage Sub-requests
12.2.1Monitoring Operations
12.2.2View Details of a Sub-Request
12.3Reschedule Expired Sub-requests
12.3.1Add a Scheduled Retry Job
12.3.2Manage Scheduled Retry Jobs

13

Processing Queue
13.1Browser Processing Queues
13.2Manage Processing Queues
13.2.1Change Status for Selected Sub-requests
13.2.2Change Status for All Sub-requests

14

Dashboard
14.1General Settings
14.1.1Refresh Dashboard
14.1.2Select Monitoring Period
14.1.3Choose Widgets
14.1.4View Statistics Details
14.1.5Change Table Settings
14.2Northbound Performance
14.3Southbound Performance

15

User Management
15.1Create a User
15.2Edit a User
15.3Unlock a User

16

Log Management
16.1Invoke a Log Search
16.2Filter Search
16.3Sort Search
16.4Cancel Search
16.5View Detailed Northbound and Southbound Information

17

Loose Error Handling Management
17.1Rule Parameters
17.2Adding a Rule
17.3Removing rules
17.4Editing a Rule
17.5Duplicating a Rule

18

Appendix A - Standard Product Activation Logic

Reference List

1   Introduction

This document is a guide to the Graphical User Interface (GUI) in Ericsson™ Dynamic Activation (EDA).

1.1   Purpose and Scope

The purpose of this document is to provide help information on how to perform configuration tasks using the GUI.

This document covers all actions available in the GUI. All features are shown in this users guide. But depending on the authorities granted, only the granted GUI items and features are visible for a specific user.

1.2   Target Group

The target group for this document is users of the Dynamic Activation GUI.

For more information about different target groups, see Library Overview, Reference [1].

1.3   Typographic Conventions

Typographic conventions are described in Library Overview, Reference [1].

1.4   Prerequisites

To perform the configuration tasks, the GUI user must know which attributes need to be configured and their respective values.

For more information, refer to the following documents:

Note:  
Screen captures in this document are examples. Some features pictured in them are license or version dependant.

2   General

This section provides basic information about the Dynamic Activation GUI.

Note:  
The supported web browsers are Chrome 58 and Firefox 52 or later versions.

2.1   Logging in

Use a web browser and direct it to the Dynamic Activation web management address. The address is as follows:

2.1.1   Logging in Using Internal Authentication

For the first time launching after installation, use the default user admin and default password admin to log in.

Note:  
The default user is defined during the installation. This user cannot be locked or deleted.

Other users must be created by System Administrator before they can log in. For information, see Section 15.

Figure 1   Dynamic Activation Logon Window

2.1.2   Logging in Using External Authentication

When using external authentication, Dynamic Activation users are created in external OpenID connect provider before login. For more information, refer to documents in related OpenID Connect Provider product.

During the OpenID authentication process, browser is redirected to the login page of external OpenID connect server.

2.2   Launchpad

Figure 2 shows the launchpad after a successful logon.

Figure 2   Launchpad

The launchpad provides portals to the following application GUIs:

2.3   Slide-in Navigation Column

When clicking on the Dynamic Activation GUI, a slide-in navigation column is displayed to provide easy accesses to all application GUIs.

2.4   User Profile

After successfully logging in, users can view and edit their own user profiles, as shown in Figure 3.

Figure 3   View User Profile

In the User Profile GUI, users can:

Figure 4   Change Password and Edit User Profile

2.5   Resilient Activation Configuration

Figure 5 shows the typical workflow of the Resilient Activation configuration.

Figure 5   Typical Configuration Workflow

For more information on this function, refer to Function Specification Dynamic Activation Execution Environment, Reference [9].

3   Asynchronous Control

The Asynchronous Control GUI shown in Figure 6 provides the controller of Asynchronous CAI3G request handler functions.

Figure 6   Asynchronous Control GUI

In Asynchronous Control GUI:

3.1   Configure Functions

To configure the Asynchronous CAI3G request handler functions:

4   CAI3G DC

Figure 7 shows the GUI used for browsing and managing CAI3G DC Routing.

Figure 7   CAI3G DC Configuration

In the CAI3G DC Configuration GUI, user can:

4.1   Create CAI3G DC Routing

To add a CAI3G DC Routing in the CAI3G DC Configuration GUI:

  1. Click . This opens the Create Routing dialog.

  2. In MO Type field, select a local MO Type from the drop-down list. Or enter the full name of a MO Type that is only available in the remote CAI3G server.
    Note:  
    Ensure that the local MOType is available in the remote CAI3G server.

  3. In Routing Method drop down list, select a routing method from the list. Then the addition parameters of the select Routing Method are displayed.
    • UnconditionalRouting

      1. Network Element - Select a remote CAI3G NE from the drop-down list.
    • NumberRangeRouting

      1. Fill in the addition parameters:

        Network Element - Select the remote CAI3G NE from the drop-down list.

        MO ID - Specify the MO ID for this MO Type, such as IMSI or MSISDN.

        Start Range - Specify the start range of the Number range.

        Stop Range - Specify the stop range of the Number range. Stop range must be larger than the start range.

      2. Click to display this routing rule in the display field. More than one routing rules can be added for Number Range Routing.

        Click to remove a selected routing rule from the display field.

    • NumberSeriesRouting.

      1. Fill in the addition parameters:

        Network Element - Select the remote CAI3G NE from the drop-down list.

        MO ID - Specify the MO ID for this MO Type, such as IMSI or MSISDN.

        Series - Specify the number series of MO ID.

      2. Click to display this routing rule in the display field. More than one routing rules can be added for Number series Routing.

        Click to remove a selected routing rule from the display field.

    • RegularExpressionRouting

      1. Fill in the addition parameters:

        Network Element - Select the remote CAI3G NE from the drop-down list.

        MO ID - Specify the MO ID for this MO Type, such as IMSI or MSISDN.

        Regular expression - Specify the regular expression of MO ID.

      2. Click to display this routing rule in the display field. More than one routing rules can be added for Regular Expression Routing.

        Click to remove a selected routing rule from the display field.

  4. Click to apply the routing rules.

4.2   Edit CAI3G DC Routing

To Edit a CAI3G DC Routing in the CAI3G DC Configuration GUI:

  1. Hover the mouse over a routing to be edit and then click . This opens the Edit Routing slide-in panel.

  2. Edit the parameters. If routing method has been changed, the additional parameters are to be changed according to the routing methods.

    For detailed information of each parameter and operation steps, see Section 4.1.

  3. Click to save the routing rules.

4.3   Delete CAI3G DC Routing

To delete a CAI3G DC Routing in the CAI3G DC Configuration GUI:

  1. Hover the mouse over a routing to be deleted and then click the .
  2. Click to confirm the deletion.

5   Cluster Strategies

The Cluster Strategy Configuration GUI shown in Figure 8 is used for browsing and managing Cluster Strategy instance.

Figure 8   Cluster Strategy Configuration

By default, the Cluster Strategy Configuration GUI displays all configured cluster strategy instance, user can:

5.1   Create Cluster Strategy Instance

To create a cluster strategy instance in the Cluster Strategy Configuration GUI:

  1. Click . This opens the Create Cluster Strategy Instance dialog.

  2. Specify a Name and select a Strategy Type. Then the specific parameters of the selected strategy type are displayed in the section Network Elements and Properties (when applicable).

    • Configure the NEs of this cluster strategy instance in Network Elements section and then click to display the configuration of each NE in the display field.

      Click to remove the selected configured NEs from the display field.

      Click to edit the parameters of a selected NE. The configured setting pops up back to the panel.

    • (When applicable) Configure the general feature of this cluster strategy type in Properties section.

    The corresponding parameters of each strategy type and their description are described in Table 1.

  3. Click to create the cluster strategy.

5.1.1   Parameters

The following table describes the corresponding parameters of each strategy type.

Table 1    Parameters of Each Strategy Type

Strategy Type

Section Name

Parameter Name

Description

ActiveActive

Network Elements

Network Element

Specify the NE to be used for the cluster strategy instance.

 

Provisioning State

This field is not applicable for ActiveActive strategy.


  • N/A: Select N/A in the drop-down list for this cluster strategy.

ActiveActive-BestEffort

Network Elements

Network Element

Specify the NE to be used for the cluster strategy instance.

 

Provisioning State

This field is not applicable for ActiveActive-BestEffort strategy.


  • N/A: Select N/A in the drop-down list for this cluster strategy.

MultipleAir

Network Elements

Network Element

Specify the NE to be used for the cluster strategy instance.

 

Provisioning State

This field is not applicable for MultipleAir strategy.


  • N/A: Select N/A in the drop-down list for this cluster strategy.

 

Order

Order 0 means that this NE works as a primary NE. There must be one and only one NE with order “0” in MultipleAir cluster.

ActiveActiveQueue

Network Elements

Network Element

Specify the NE to be used for the cluster strategy.

 

Provisioning State

  • On: to execute the provisioning commands directly.

  • Off: to discard the provisioning commands.

  • Off-Store: to store the provisioning commands into processing queue. The provisioning commands are only enqueued when they are changing the data in NE (such as create, set, and delete operation).


There must be at least one NE with provisioning state On in the cluster.

Properties

Auto Off-Store

Indicates whether the Auto Off-Store function is enabled or not. It is disabled by default.


When property Auto Off-Store is enabled, if the provisioning commands fail for some continuous reasons within a period, the provisioning state of this NE is automatically switched to Off-Store. (The reason is configured by Response Code. The period is configured by Minimum Duration (seconds) for continuous Response Code.) At the same time, an event is sent out to inform provisioning state changed for this NE.

   

Minimum Duration (seconds) for continuous Response Code

This field only accepts numbers.


For example, 600.

   

Response Code

This filed is a regular expression, which is used for matching valid Respond Code.


For example, to match 5 digits respond code starting with 101 or 105, regular expression “(101[0-9][0-9]|105[0-9][0-9])” is used in this filed.

ActivePassive

Network Elements

Network Element

Specify the NE to be used for the cluster strategy.

 

Provisioning State

  • On-Active: indicates that the NE is ready to receive provisioning requests.

  • On-Passive: indicates that the NE is stand-by.

  • Off: indicates that provisioning is not sent to this NE.


There must be one NE with provisioning state On-Active and one or more NEs with provisioning state On-Passive/Off in the cluster.

Properties

Error Code for detecting passive status of network element

All requests are sent to the On-Active node until it fails owing to link error or matching the error code for detecting passive status of NE (configured by this feature). When this happens, it provisions to other On-Passive nodes in the cluster one by one. The first node, whose response is not link error or the error code configured by this feature, is to be taken as a new On-Active node. If no On-Passive nodes are qualified for On-Active, the original On-Active one keeps its provisioning state.

PrimaryBackup

Network Elements

Network Element

Specify the NE to be used for the cluster strategy.

 

Provisioning State

  • On: to execute the provisioning commands directly.

  • Off: to discard the provisioning commands.

  • Off-Store: to store the provisioning commands into processing queue. The provisioning commands are only enqueued when they are changing the data in NE (such as create, set, and delete operation).


There must be at least one NE with provisioning state On in the cluster.

 

Primary Network Element

The configuration of primary network must follow the rules:


  • There must be one and only one primary NE.

  • A primary NE can only be in provisioning state ON.


Make sure that the processing queue is empty before changing the status of an NE, refer to Section 13.

Properties

Auto Off-Store

Indicates whether the Auto Off-Store function is enabled or not. It is disabled by default.


When property Auto Off-Store is enabled, if the provisioning commands fail for some continuous reasons within a period, the provisioning state of this NE is automatically switched to Off-Store. (Where the reason is configured by Response Code. And the period is configured by Minimum Duration (seconds) for continuous Response Code.) At the same time, an event is sent out to inform provisioning state changed for this NE.

   

Minimum Duration (seconds) for continuous Response Code

This field only accepts number.


For example, 600.

   

Response Code

This filed is a regular expression, which is used for matching valid Respond Code.


For example, to match 5 digits respond code starting with 101 or 105, regular expression “(101[0-9][0-9]|105[0-9][0-9])” is used in this filed.

5.2   Edit Cluster Strategy Instance

To edit a cluster strategy in the Cluster Strategy Configuration GUI:

  1. Hover the mouse on a cluster strategy instance to be edit and then click . This opens the Edit Cluster Strategy Instance slide-in panel.
  2. Edit the parameters. For detailed information of each parameter and operation steps, see Section 5.1.
    Note:  
    For cluster strategy PrimaryBackup, to change the Network Element to a primary NE, the processing queue must be empty. Otherwise, it is not allowed.

  3. Click to save the cluster strategy instance.

5.3   Delete Cluster Strategy Instance

To delete a Cluster Strategy Instance in the Cluster Strategy Configuration GUI:

  1. Hover the mouse over a Cluster Strategy Instance to be deleted and then click .
  2. Click to confirm the deletion or click to cancel the delete action.

6   MO Type and NE Type Mapping

Mapping between MO type and NE type enables routing sub-requests to the corresponding Resource Queues. The MO Type and NE Type Mapping GUI is shown in Figure 9 and described afterwards.

Figure 9   MO Type and NE Type Mapping

In the MO Type and NE Type Mapping GUI:

6.1   Mapping and Unmapping in Southbound MO Types List

To map (or unmap) an MO type and an NE type in panel 1, do the following:

  1. Click (or ) of a desired southbound MO.

    This pops up a list of all available NE types on the Dynamic Activation.

  2. Click the desired NE type to create (or remove) the mapping between the chosen MO and NE types.

The newly created (or removed) mapping is displayed (or removed) in graph 3.

6.2   Mapping and Unmapping in Graph

An alternative operation is available in the MO Type and NE Type Mapping GUI that is shown in Figure 9.

7   Notification Rule Configuration

Figure 10 shows the configuration of intermediate notification for sub-requests in Resource Queues.

Figure 10   Notification Rule Configuration GUI

Available information is:

7.1   Configure Notifications

To configure the intermediate notification settings on a target resource:

  1. In the Notification Rule Configuration GUI, click a row to open the Edit notification rule slide-in panel.

  2. Configure whether to send an intermediate notification based on the Successful / Failed response of sub-requests.
  3. (Optional) Click a retry rule to add (or remove) it as a rule that can trigger a notification when a sub-request is retried.
    Note:  
    For more information on how to configure retry rules, see Section 10.

  4. Click to apply the configuration.

8   Management

8.1   General

Note:  
  • Do not use the Back and Forward buttons in the web browser, as this causes an error.
  • Do not use multiple browser windows or browser tabs simultaneously on one workstation, as this causes an error.

8.1.1   GUI Overview

The default Dynamic Activation GUI consists of the following parts.

Figure 11   GUI Overview

8.1.1.1   Main Area

The general items of the main area are explained in Table 2.

Table 2    GUI Main Area

Item

Description

About

Shows information about software version.

Site Map

Hyperlinks to Dynamic Activation GUI feature tabs and subtabs.

User Guide

Link to Dynamic Activation GUI User Guide.

Logout

To log out from the Dynamic Activation GUI. After logging out, the logon window shows.

8.1.1.2   Feature Bar

All tabs in the GUI feature bar including their subtabs are shown in Figure 12.

Figure 12   GUI Features

Note:  
Log Management is a link to the Log Management GUI which is designed following the latest branding guideline.

Hyperlinks to the feature tabs are reachable from Site Map.

8.1.1.3   Working Area

Depending on which tab in the GUI that is selected, the content of this area is changed.

On the GUI front page, a License Capacity Warning table is shown in the working area if there are active license capacity warnings at the moment. The table contains information about License ID, Name of the license and days until the provisioning is stopped.

Figure 13   List of License Capacity Warnings

8.1.2   GUI Icons

The common icons used in the Dynamic Activation GUI are shown in Table 3.

Table 3    GUI Icons

Icon

Description

View Details

Edit

Update

Remove

Copy

Undo Change

Backup

Restore

(green)

Activate

(red)

Deactivate

Filtering

Sort Column

Download

(green)

Collapse Successful Log

(green)

Expand Successful Log

(red)

Collapse Failed Log

(red)

Expand Failed Log

Failed or Suspended

Successful

Helptext

8.2   Activation Logic Control

This section covers the Activation Logic tab in the Dynamic Activation GUI. It consists of the Activation Logic and Options subtabs.

8.2.1   Activation Logic

The Activation Logic subtab contains a list of all Dynamic Activation components, as shown in Figure 14. The following is listed in this tab:

For a list of the components available in the Dynamic Activation standard product, see Section 18.

Figure 14   Activation Logic

The columns can be sorted through the filtering function, which can be useful when the list of Activation Logic components is long.

8.2.1.1   Activation Logic Properties

This section contains a table, displaying all the Configuration Data properties that exist in the Activation Logic subtab.

Table 4    Activation Logic Properties

Property

Description

Activation Logic (1)

AllowSipUriWithoutDomain

Indicates whether IMPU without domain is allowed or not.


Default value: false


  • false - IMPU without domain is not allowed

  • true - IMPU without domain is allowed

HSS IMS Provisioning

AUTCHOVERMAND

This property enables a check whether AUC subscription data for the new IMSI is mandatory when an initiation of IMSI changeover for an HLR subscription is performed.


Value range: 01


Default value: 0


0 - AUC subscription data mandatory.


1 - AUC subscription data not mandatory.

CUDB IMSI Changeover Provisioning

AUTHDMAND

This property enables a check whether the AUC subscription data is mandatory when new HLR subscription data is added to the CUDB.


Property value:


Value range: 01


Default value: 1


0 - AUC subscription data mandatory


1 - AUC subscription data not mandatory

HLR Subscriber Provisioning (applicable for HLR subscription and M2M subscription)

AuthenticationRealm

The authentication realm of HSS. For example, domain.xml.


This parameter is empty by default.

Monolithic HSS Provisioning

CAFlag(2)

Identifier indicating whether this Activation Logic component is a CA (Customer Adaptation) JDV.


Value range: true or false

All activation logics deployed in the system

CentralImeiDb

This parameter indicates if the “Central IMEI DB” is connected or not.


The parameter is checked when equipment objects (imeiData) are created, set, or deleted.


Value range: true or false


Default value: false


true - Central IMEI DB connected


false - Central IMEI DB not connected

EIR Provisioning

ChargingTimeZone

The operators timezone deviation in hours and minutes from the UTC.


ChargingTimeZone is always preceded by either a ‘‘+ ’’ or ‘‘- ’’ sign.


Value Range: [+/-]0000 to [+/-]2359

AIR Provisioning

CompanySettingName

The name space and name of Company Setting


The format of this parameter is x,y;x,y;...


x: Namespace


y: Parameter name


For details on the parameters, refer to BCE-related documents.


If companySetting name is configured in the Create request and CompanySettingName is configured on GUI, Dynamic Activation performs the validation:


  • If the companySetting name is consistent with the GUI configuration, the provisioning request is sent to BCE.

  • If the companySetting name is not consistent with the GUI configuration, an error is returned.


The default value is UP,PNP_ATTACH_CODE_LENGTH;UP,CDG_NO_ANSWER_TIMEOUT;UP,CDG_INTERMITTENT_QUEUE_MESSAGE_INTERVAL;UP,CDG_AGENT_BUSY_TIMEOUT; UP,CDG_AGENT_CANCEL_TIMEOUT;UP,CDG_AGENT_TIMED_OUT_TIMEOUT;UP,CDG_AGENT_UNAVAILABLE_TIMEOUT;UP,AA_TIMEOUT;UP,RESTRICTED_SHORT_NUMBERS_PATTERN; COH,COH_SMS_REMINDER_ENABLED;COH,COH_SMS_REMINDER_TIME_BEFORE_START;COH,COH_MIN_PIN_CODE_LENGTH

BCE resource Provisioning

CSPSMAND

This parameter enables a check if the IMSI in HLR subscription must be deleted before deleting AUC subscription data from the CUDB.


Value range: true or false


Default value: false


true - Mandatory


false - Not mandatory

AUC Subscriber Provisioning (applicable for HLR subscription and M2M subscription)

CertProfile

The certificate profile name that is defined in the ECAS server. It is used when a certificate is signed.


For information about the certificate profile, refer to http://ejbca.org/docs/concepts.html#Certificate Profile.


Default value: ENDUSER

ECAS Provisioning

CertPEMFormat

Indicates if the signed certificate is in the PEM format. Case insensitive YES means true, otherwise it means false.


Default value: YES

ECAS Provisioning

DisabledPrintoutSuds

This property disables Subscriber Data (SUDs) that are not to be returned in the printout response. The SUD names need to be space separated.


Value range: Any simple SUD, for example, CAT, PWD, SCHAR, TSMO, and more.


Default value: Empty string, meaning that all SUDs are enabled.

HLR Subscriber Provisioning (applicable for HLR subscription and M2M subscription), HLR Massive Provisioning

DnsDomainCreateCommands(3)

The list of CLI command to be sent to IPWorks when adding a domain data.


Value range: Any json format string


Default value: Empty string


Format:


{
"<sequence number 1>":"<dns command>",
"<sequence number 2>":"<dns command>",
...
}


sequence number - is the order of the dns command send to IPWorks.


dns command - is the CLI command send to IPWorks. If the command contains string @DOMAIN@, this string is replaced by the actual Domain Data.


For example:


{
"1":"create masterzone iDNS1 @DOMAIN@ -set option=\"notify-source 172.17.4.37\"",
"2":"modify masterzone iDNS1 @DOMAIN@ -add AuthoritativeName=\"www.ericsson.com\""
}

IPWorks/ENUM Provisioning

DnsDomainDeleteCommands (3)

The list of CLI command to be sent to IPWorks when removing a domain data.


Value range: Any json format string


Default value: Empty string


Format:


{
"<sequence number 1>":"<dns command>",
"<sequence number 2>":"<dns command>",
...
}


sequence number - is the order of the dns command send to IPWorks.


dns command - is the CLI command send to IPWorks. If the command contains string @DOMAIN@, this string is replaced by the actual Domain Data.


For example:


{
"1":"delete masterzone @DOMAIN@ 0.0.4.3.e164.arpa",
"2":"delete arecord @DOMAIN@.eric.com;address=10.0.0.2",
"3":"delete dnsserver dns_U1"
}

IPWorks/ENUM Provisioning

EnumDomain (3)

Define the condition to assign the ENUM domain for msisdn or e164.


Value range: Any json format string


Default value: e164.arpa


Empty string means that e164.arpa is used as ENUM domain for all parameters.


Format:


{
"msisdn": [
{"serie": "<serie value>","length": <length>,"domain": "<domain value>"}
...
],
"e164": [
{"serie": "<serie value>","length": <length>,"domain": "<domain value>"}
...
]
}


serie - the first n digits(4) of msisdn or e164 ('tel:' and '+' are not counted).


length- the length of msisdn or e164.


domain- the value of the ENUM domain.


domain is assigned when both the serie and length are matched. For regular msisdn or e164(which contains !\.\*! in the parameter), it only needs to match the serie and less than or equal to the length.


If more than one condition is matched, the first matched domain is to be selected.


If no condition is matched, e164.arpa is to be assigned.


For example:


{"msisdn":[{"serie":"123","length":11, "domain":"msisdn.arpa.a"}],"e164":[{"serie":"123","length":11,"domain":"e164.arpa.a"}]}

IPWorks/ENUM Provisioning

ErrorCodeMapping

Specifies the error code mapping for MTAS provisioning.


Value range: 1 or 2. Default value is 2.


If value 1 is set, the following applies (for keeping backward compatibility):
- When MTAS sends fault code between 1001-2999, Dynamic Activation replies with response code 2002.
- When MTAS sends fault code between 3000-3999, Dynamic Activation replies with response code 36501.
- When MTAS sends any other fault codes, Dynamic Activation replies with response code 36502.


If value 2 is set, the following applies, for elaborating error mapping:
- When MTAS sends fault code 3002, Dynamic Activation replies with response code 36503.
- When MTAS sends fault code 3013, Dynamic Activation replies with response code 36504.
- When MTAS sends any other fault codes, Dynamic Activation replies as described above for value 1.


For more information about error code description, refer to MTAS Provisioning over CAI3G, Reference [7].

MTAS Provisioning

ExARD

This property indicates which one of the following two parameters is used for the access restriction in the inbound interface:


  • AccessRestriction for HSS 11B

  • ExtendedAccessRestriction for HSS 12A and onwards


Value range: true or false.


Default value: true


true - Use ExtendedAccessRestriction in the inbound interface to provision HSS 12A and onwards.


false - Use AccessRestriction in the inbound interface to provision HSS 11B.

HSS EPS Provisioning

ExAssociationId

This property controls the maximum length of associationId attribute:


  • false - No extensional ID is used. Maximum length of an association ID is 32 characters.


The default value is false.


Note: Contact Ericsson support organization if ExAssociationId needs to be changed. ExAssociationId attribute value must be coordinated with service logic implemented in other nodes. This value must not be modified if there is maiden installations or new migrations from Monolithic systems.

HSS IMS Provisioning

ExMaxNumberOfContacts

This property indicates which one of the following two ranges is used for the maximum number of contacts in the inbound interface:


1–5 and default value 1 for HSS 12B


1–200 for HSS 14A and onwards


Value range: true or false


Default value: true


true - Use maximum number of contacts with range [1-200] in the inbound interface to provision HSS 14A and onwards.


false - Use maximum number of contacts with range [1-5] and default value 1 in the inbound interface to provision HSS 12B.

HSS IMS Provisioning

ExValidation

Enables or disables support for password encryption.


Value range: true or false


Default value: true


true - support for password encryption is enabled.


false - support for password encryption is disabled.


Must be set to true when HSS validator is corresponding to the following HSS-FE releases:


  • 12A R5F or higher

  • 12B R6D/1 or higher

  • 14A R1A or higher

HSS Provisioning IMS

EntityProfile

The End Entity Profile name that is defined in the ECAS server. It is used when a certificate is signed.


For information about the End Entity Profile, refer to http://ejbca.org/docs/concepts.html#End Entity Profile


Default value: EMPTY

ECAS Provisioning

FamilyProvisionTowardsCUDB

Indicates whether SAPC family data provisions to CUDB or not when routing CUDB_SAPC and SAPC are both configured.


  • NO - SAPC family data provisions to SAPC-FE

  • YES - SAPC family data provisions to CUDB


Default value: NO

SAPC Service Provisioning

GetCompanySetting

The parameter value is Yes or No, which is case insensitive:


  • Yes: In getCompanyResponse, Dynamic Activation returns the companySetting information according to the CompanySettingName configuration;

  • No: In getCompanyResponse, Dynamic Activation does not return the companySetting information.


Default value: No.

BCE resource Provisioning

GenericEricssonNonSIMSolution

Generic Ericsson HSS data model without the xB2BUA deployment.


Value: YES or NO


Default value: YES


If the value is set to YES, the VoWifiService interface (Create/Set/Delete) is used for provisioning of AAA, HSS, and Ericsson Certificate Authority Server (ECAS).


If the value is set to NO, the NonSIMHSSUser interface (Set) is used for provisioning of HSS. And the VoWifiService interface (Create/Set/Delete) is used for provisioning of AAA and ECAS.

Wi-Fi Calling for Multiple Device Voice over Wi-Fi Subscription

HLRNotificationPendBlock

Enable or disable the Data Consistency Assurance in Core Network and CUDB feature. If enabled, Dynamic Activation blocks an HLR provisioning command if there is already a pending notification in progress. Dynamic Activation retries the blocked provisioning command several times, until the previous one is finished.


Value range: disabled and enabled


Default value: disabled

HLR Subscriber Provisioning,
HLR Massive Provisioning

HLRNotificationNumberOfRetries

The maximum number of retries for Dynamic Activation to send the blocked provisioning command towards the HLR.


Value range: 010


Default value: 5

HLRNotificationRetryFactor

Specifies the factor for extending the waiting time before each retry, so these retries can have increasing intervals.


Value range: 110


Default value: 2

HLRNotificationWaitTime

Specifies the timer (in ms) for calculating intervals of the retries towards the HLR.


Value range: 0120000ms (2 mins)


Default value: 2000ms

HLRNotificationTimeout

Specifies for how long a pending HLR Notification blocks new provisioning commands. When the time-out is exceeded, Dynamic Activation continues the corresponding provisioning command.


Value range: 0120000ms (2 mins)


Default value: 62000ms (62s)

HSSSubscriberFormat

The subscriber ID format of HSS.


Value: The correct format used for the monolithic HSS subscriber ID, which is used for Ericsson Non-SIM in the HSS IMPI operation.


Default value: <imsi>@<domain>

Wi-Fi Calling for Multiple Device Voice over Wi-Fi Subscription

IssuerDN

The CA’s Distinguish Name (DN) created in ECAS, which is used to sign the certificate.


Ensure that the CA name must be as same as the Common Name (CN) of DN when creating a CA in ECAS.


This configuration is used for ECAS provisioning if the CAI3G request does not contain the IssuerDN.

ECAS Provisioning

MaxParallelRequests(5)

Specifies how many subscribers are updated in parallel when a massive update command is executed.


Value range: 1–1024


Default value: 10


MaxParallelRequests has to have a value lower than the total pool size.

AUC Massive Provisioning, HLR Massive Provisioning, HSS EPS Massive Provisioning, MNP Provisioning, M2M Profile Provisioning, M2M Service Profile Provisioning

MaxRetries

The maximum number of retries for an LDAP operation to CUDB when an LDAP Collision (CDC) occurs.


Value range: 065535


Default value: 10

AUC Massive Provisioning, AUC Subscriber Provisioning (applicable for HLR subscription and M2M subscription), CUDB Subscriber Provisioning, HLR Massive Provisioning, HLR Profile Provisioning, HLR Service Associated Data Provisioning, HLR Subscriber Provisioning (applicable for HLR subscription and M2M subscription), HSS EPS Massive Provisioning, MNP Provisioning, Dynamic Activation Scheduled Procedures, M2M Profile Provisioning, M2M Service Profile Provisioning, SAPC Provisioning, ENUM Layered Resource Provisioning

MaxRetry

The maximum number of times that a JDV request is retried.


Value range: 010


Value 0 or empty indicates that no retries are to be made.


If the value is invalid or out of range, it is set to 0.


The default value is 3.

Monolithic IPWorks AAANSD User Provisioning

MaintenanceMode

Indicates whether AAA is in maintenance mode. In this mode, all AAA commands are rejected by AAA JDV logics with the specific error code 35257.


Values: YES or NO, which is case insensitive.


If it is set to YES, JDV AAA rejects all the requests.


If the value in this field is not YES or NO, it is set to NO.


Default value: YES

Monolithic IPWorks AAANSD User Provisioning

MNCLength

Specifies the Mobile Network Code length


Value range: 2 or 3


Default value: 2

CUDB IMSI Changeover Provisioning

NominationList

Specifies which list is the nomination list (0-9) in equipment data.


This parameter is checked when equipment objects (imeiData) are created, set, or deleted.


Value range: String 09


Default value: 1

EIR Provisioning

NPOwnNetworkPrefix

The network prefix of the home operator who uses Dynamic Activation


Example: 19021902


Value pattern: (#1(0|1|2|3|4)|[0-9]){1,10}


Default value: Empty string, which means that MNP provisioning in HLR provisioning is bypassed.

HLR Subscriber Provisioning (applicable for CAI and CAI3G)

OriginOperatorID

The origin ID of the operator.


Default value: operater

AIR Provisioning

ProvisioningUri

The URI used for AIR provisioning.


Default value: Air

AIR Provisioning

The URI used to send provisioning requests


Default value: ejbca/ejbcaws/ejbcaws?wsdl

ECAS Provisioning

RetryErrorMessage

The key words list used in error messages. The key words are separated by a #. When an error message contains any words in the list, resend the command to AAA. For example,
already exists#No matching object(s)


Default value: empty


For Failover NE group, the RetryErrorMessage value must contain " Failed to connect to ssh server#Network closed".

Monolithic IPWorks AAANSD User Provisioning

RetryInterval

The time (in seconds) to wait before another retry. Only integer value is valid.


Value range: 010


Value 0 or empty indicates that there is no interval between the retries.


If the value is invalid or out of range, it is set to 2.

Monolithic IPWorks AAANSD User Provisioning

RevokeCertificateByUserName

Indication for revoking user certificate by username or certificate serial number


Values: YES or NO


Default value: NO


If it is set to YES, the VoWifiService uses username as identity towards ECAS and it revokes all users certificates.


If it is set to NO, the VoWifiService uses certificate serial number as identity towards ECAS and it just revokes the user-specific certificate.

Wi-Fi Calling for Multiple Device Voice over Wi-Fi Subscription

Rootdn(6)

The Rootdn is used for creating objects in CUDB from the Dynamic Activation system.


Value range: 0255 characters.


Default value: dc=operator,dc=com

AUC Massive Provisioning, AUC Subscriber Provisioning (applicable for HLR subscription and M2M subscription), CUDB IMSI Changeover Provisioning, CUDB Subscriber Provisioning, EIR Provisioning, HLR Massive Provisioning, HLR Profile Provisioning, HLR Service Associated Data Provisioning, HLR Subscriber Provisioning (applicable for HLR subscription and M2M subscription), HSS Provisioning AVG, HSS EPS Massive Provisioning, HSS Provisioning EPS, HSS Provisioning IMS, MNP Provisioning, Dynamic Activation Scheduled Procedures, DAE Provisioning, SAPC Provisioning, AAA Provisioning, M2M Profile Provisioning, M2M Service Profile Provisioning, CUDB SUBDEL Provisioning, ENUM Layered Resource Provisioning, AAANSD Layered provisioning

The root DN of HSS.


The default value is applicationName=HSS,nodeName=jambala.

Monolithic HSS Provisioning of IMS

Routeuserphone

This property indicates whether routing naptrTxt with user=phone. user=phone is added after the naptrTxt and separated by a semicolon ";".


Example: !^.*$!SIP:+12225550189@example.com;user=phone!


Value range: 01


Default value: 0


0 - Route NaptrTxt without user=phone.


1 - Route NaptrTxt with user=phone. Except if the value of SIP URI contains non-numerical character, it routes NaptrTxt without user=phone.

IPWorks/ENUM Provisioning

ServiceCheckMsisdnCho

This property indicates whether blocking the provisioning for MSISDN Changeover when the subscriber has services other than AUC, HLR, and EPS.


Value range: true or false


Default value: true


true - Block the provisioning.


false - Do not block the provisioning.

CUDB IMSI Changeover Provisioning

SubjectDN

The subject DN postfix.


CN=username + SubjectDN is used as the default value of subjectDN if the CAI3G request does not contain the SubjectDN.

ECAS Provisioning

TTL

The default value of Time To Live in seconds of the DNS record.


Value range: Integer 02147483647

AF Provisioning

UserPasswordEncryption

This parameter shows whether UserPassword is encrypted.


Values: YES or NO, which is case insensitive.


Default value: YES

Monolithic HSS Provisioning

X3GPPAssertedIdentity

The authentication realm of PGM Document. This is a Tel URL or SIP URL.


Default value: sip:4687500061@tcv.ics.se

PGM Document resource Provisioning

Xcaproot

The XCAP root of PGM Document.


Default value: services.

PGM Document resource Provisioning

(1)  This column shows in which Activation Logic Target a specific property exists.

(2)  This is not a configurable property. It is set during deploy time of a component.

(3)  If the string or commands contains quote(“), it needs to be escaped by backslash(\).

(4)  n is less than or equal to 15 and greater than 0

(5)  Increasing the value can affect normal provisioning throughput when a massive update command is executed. This affects only the Payload node that executes the massive update operation.

(6)  Make sure that Rootdn  is the same as for LDAP data source, and matches the configured Rootdn value in CUDB. The parameter is case-sensitive.


8.2.1.2   View Activation Logic Properties

To view an activation Logic, follow these steps:

  1. Click the View Details icon for the Activation Logic to view.

    A new page is displayed, holding information about properties, and values set for the current activation logic. Depending on the Activation Logic, both Configuration Data and Target Data is shown.

  2. Click Done if the information stated for this activation logic is accurate.
  3. Click Change This... to edit the property values. For information on how to edit an activation logic, see Section 8.2.1.3.

8.2.1.3   Edit Activation Logic Properties

To change the properties of an Activation Logic, follow these steps:

  1. Click the Change... icon for the Activation Logic to modify.

    A new page is shown, displaying the Configuration Data properties that are possible to modify for the current Activation Logic. For information about the different properties that are possible to modify, see Table 4.

  2. Modify the value of the properties as needed.
  3. Click Apply.

    A verification page is displayed. The page shows all the parameters defined for the Activation Logic property. Users can continue to edit the parameters as needed by clicking appropriate icons. If the parameters are correctly set, click Done.

8.2.1.4   Back Up Activation Logic Properties

To back up configuration data in Activation Logic, follow these steps:

  1. Click the Backup icon for the Activation Logic to back up.

    A new page is shown, containing a Configuration Data Name text area and a list of the Configuration Data properties included in this specific Activation Logic.

  2. Label the backup by entering a name in the Configuration Data Name text area.
  3. Click Apply.

    A verification page is displayed. The page shows all the parameters defined for the Activation Logic property. Users can continue to edit the parameters as needed by clicking appropriate icons. If the parameters are correctly set, click Done.

8.2.1.5   Restore Activation Logic Properties

To restore an Activation Logic, follow these steps:

  1. Click the Restore icon for the Activation Logic to restore.

    A new page is shown, displaying a scroll-bar containing the Activation Logic backups. And a list of the current Configuration Data properties for this specific Activation Logic.

  2. Select the desired backup in the scroll-bar.
  3. Click Apply.

    A verification page is displayed. The page shows all the parameters defined for the Activation Logic property. Users can continue to edit the parameters as needed by clicking appropriate icons. If the parameters are correctly set, click Done.

8.2.2   Options

Users can change the default setting of the RootDN attribute for all applicable components in the Activation Logic, and for the CUDB Lookup. See Figure 15.

It is possible to override the default setting by updating the components individually. For Activation Logic components, see Section 8.2.1.1. For the CUDB Lookup, see Configuration Manual for Subscriber Activation, Reference [2].

Figure 15   Options Window

The following table describes the properties in the Options window.

Table 5    Options Configuration

Property

Description

Change All RootDN's To:

The default RootDN value that is to apply for all JDVs in Activation Logic and for CUDB Lookup. (1).

(1)   Make sure that Rootdn  is the same as for LDAP data source, and matches the configured Rootdn value in CUDB. The parameter is case-sensitive.


8.3   Network Elements Control

From the Network Elements tab, it is possible to administer Network Elements (NE), NE groups, and routing.

8.3.1   Network Elements

From the Network Elements subtab it is possible to administer NE configurations, see Figure 16.

Figure 16   Network Elements Window

In the Network Elements page, a table displays all configured NEs. It shows the NE Name, Function(s), Protocol, and Status. Operators can Add, View, Copy, Edit, Remove, and Compare NEs by clicking appropriate icons.

8.3.1.1   Adding Network Elements

To add an NE, follow these steps:

  1. Click Add.
  2. In Network Elements - Add - Step 1 / 2, enter the name of the NE in the Name field, and select the protocol for the NE from the drop-down list.

    By default, the Active Resource ID for the NE is assigned.

    To change the default Active Resource ID, press Advanced.

    Information about the fields in this page is available in Section 8.3.1.6.

    Click Next.

  3. In Network Elements - Add - Step 2 / 2, specify the protocol parameters, see Section 8.3.1.6. The fields that are available depend on the protocol selected for the NE and on installed features. Information about most common fields is available in Section 8.3.1.7.
  4. Click Apply.

    A verification page is displayed. The page shows all the parameters defined for the NE. Users can continue to edit the parameters as needed by clicking appropriate icons. If the parameters are correctly set, click Done.

8.3.1.2   Copying Network Elements

To copy an existing NE, follow these steps:

  1. Click the copy icon for the NE to copy.
  2. In Network Elements - Add - Step 1 / 2, change the name of the NE in the Name field. And select the protocol for the NE from the drop-down list.

    By default, the Active Resource ID for the NE is assigned.

    To change the default Active Resource ID, press Advanced.

    Information about the fields in this page is available in Section 8.3.1.6.

    Click Next.

  3. In Network Elements - Add - Step 2 / 2, change the protocol parameters, see Section 8.3.1.6. The fields that are available depend on the protocol selected for the NE and on installed features. Information about most common fields is available in Section 8.3.1.7.
  4. Click Apply.

    A verification page is displayed. The page shows all the parameters defined for the NE. Users can continue to edit the parameters as needed by clicking appropriate icons. If the parameters are correctly set, click Done.

8.3.1.3   Editing Network Elements

To change the parameters of an NE, follow these steps:

Note:  
Editing an NE during traffic terminates existing connections and can cause provisioning failures.

  1. Click the change icon for the NE to modify.

    A new page is shown, containing the General, and the Protocol parameters tabs.

  2. Click each tab to change parameters as needed.

    Information about most common fields is available in Section 8.3.1.6.

  3. Click Apply.

    A dialog is displayed stating that the change terminates existing connections and ongoing provisioning traffic for this NE. If the parameters are correctly set, click OK to proceed.

8.3.1.4   Removing Network Elements

Note:  
Before removing an NE, consider the following:
  • All requests associated to the NE must be deleted from the Processing Queue. Otherwise the requests remain in the database. For more information, see Section 13.1.
  • A Network Element used in a Network Element Type cannot be removed.

To remove an NE, follow these steps:

  1. Click the remove icon for the NE.

    A window opens to confirm the remove operation.

  2. Click OK.

Tips!

If an NE is removed without removing its associated requests first, recreate a new NE with the same name. So you can remove all the requests in the Processing Queue GUI.

8.3.1.5   Comparing Network Elements

It is possible to compare two NEs to see the difference between their parameters.

To compare NEs, follow these steps:

  1. In the NEs table, select two NEs to compare.
  2. Click Compare.

    A page that shows the parameters of the two NEs side by side is displayed. Information about most common fields is available in Section 8.3.1.6.

8.3.1.6   Network Elements Parameters

A Network Element is defined by the following parameters.

Table 6    Network Element Parameters

Parameters

Property

Description

General

Name

The name for the NE.


Allowed characters are a-z, A-Z, 0–9, - and _. White spaces are not considered, they are automatically removed.

Protocol (1)

The connection protocol for the NE.


The following protocols and protocol parameters are included:


Version (2)

The version of the NE.

Active Resource ID

Unique identity for the NE used in alarm handling.


This parameter is only available in Advanced mode.

State

The state of an NE. The value can be either Active or Inactive. This parameter is only applicable when NE Group Type Active-Active is used.

Status

Status of the NE (Up or Down).


The value is generated automatically by the system.

Network Element Type

The NE type to which the NE belongs.

(1)  Depending on customer adaptations or installed features, the connection protocols can differ. Only the protocols listed in the column to the right are supported.

(2)  Currently only supported for MTAS. For more information, refer to Configuration Manual for Subscriber Activation, Reference [2].


8.3.1.7   Connection Protocol Parameters

The following table describes the connection protocol parameters for all the NEs, including the internal NEs:

Table 7    Connection Protocol Parameters

Parameter

Description

Pool Size

The maximum number of open connections in the pool towards the NE for each PL node.


The number of open connections in the pool will vary over time on needed basis.


It is suggested to set this parameter to a number not exceeding the expected number of concurrent requests for each PL node.


The Pool Size is set for 1x per PL node. For example, if total sessions for an HLR-FE are 20 and two PL blades handles traffic, the Pool Size to configure is 20/2 = 10.


Value range: 11024


Default value: 10


This is a mandatory parameter.

Idle Timeout (minutes)

The maximum time, in minutes, a connection is allowed to be idle (unused) in the pool.


A periodic check is performed to find and close timed out connections.


Value range: 12147483647


Default value: 1

Blocking Timeout (ms)

The time, in milliseconds, to wait for a free connection in the pool.


Value range: 0300000


Default value: 10000


If the time is exceeded, an Out of Resources exception is raised.

8.3.1.7.1   LDAP Connection Protocol Parameters

The following table shows more LDAP connection protocol parameters.

Table 8    LDAP Connection Protocol Parameters

Parameter

Description

Host

IPv4/IPv6(1) address or hostname.


The host containing the database.

Port

Defines to which port LDAP listens.


Value range: 165535

User DN

The username to log on to the database. For example, cn=manager,dc=operator,dc=com.

Heartbeat DN

The distinguished name (DN) that is fetched during heartbeat checks. For example, ou=mscCommonData,dc=operator,dc=com

Number of Retries

Number of times that connection is retried, if detected LDAP busy failure.


Value range: 010


Default value: 3

Retry Time Interval (ms)

After receiving an LDAP error, this parameter determines how long to wait before trying again. For description of the LDAP error code, refer to Function Specification Resource Activation, Reference [4].


Value range: 060000


Default value: 1000


Retry Time Interval (ms) has to have a value lower than Long Retry Time Interval (ms).

Long Retry Time Interval (ms)

After receiving an LDAP error, this parameter determines how long to wait before trying again. For description of the LDAP error code, refer to Function Specification Resource Activation, Reference [4].


Value range: 0180000


Default value: 15000

Response Timeout (ms)

Response time-out in milliseconds represents the read time-out for LDAP operations. If the LDAP connector does not get an LDAP response within the specified time, it ends the read attempt. A value less than or equal to zero means no read time-out is specified. This is equivalent to waiting for the response infinitely until it is received.


This time-out is not used for detecting long running requests, but rather to ensure that the LDAP server is continuously responding to the LDAP client. This means that a request can be ongoing for several minutes, even if the response time-out is set to just a few seconds, without being ended.


Value range: 086400000


Default value: 11000 (2)


Value 0 means that the time-out is disabled and can be used for Massive Searches. When Timeout is disabled, there is no guarantee that the connection is closed if there is network disturbance.


Response Timeout is recommended:


  • To be activated for Individual Provisioning and Massive Updates, that is ResponseTimeout>0.

  • To be set to a high value for Massive Searches, max value to use is 86400000, which is equivalent to 24 hours.

  • To be set to a higher value on the tertiary CUDB node in a CUDB Group. This is to avoid all CUDB nodes to be blacklisted if there is slow connections.


Note: Too low Response Timeout value for secondary or tertiary CUDB nodes can cause all CUDB nodes to be blacklisted. Response Timeout for secondary and tertiary CUDB nodes must have a sufficient high value, so it can handle single CUDB transactions with longer response time.

Connection Timeout (ms)

Time in milliseconds to wait for a connection attempt to get contact, before ending the attempt.


Value range: 0300000


Default value: 11000

Retry Factor

After receiving some communication faults from the LDAP server, Retry Factor together with Number of Retries and Retry Time Interval determines how long to wait before a retry.


Value range: ≥ 1


Default value: 2

Password

The password to log on the database.

Binary Attributes

A list of what LDAP attributes are binary.


Default value: Configured for CUDB.


For the Binary Attributes parameter, choose the default Configured for CUDB radio button.

(1)  IPv6 is not valid for Native and CEE deployments.

(2)  The default value is based on the Open Shortest Path First (OSPF) dead time-out to avoid premature failover or blacklisting.


8.3.1.7.2   Telnet Connection Protocol Parameters

The following table shows more telnet connection protocol parameters.

Table 9    Telnet Connection Protocol Parameters

Parameter

Description

Host

IPv4/IPv6(1) address or hostname.


The host containing the telnet server.

Port

Defines to which port telnet listens.


Value range: 1–65535

username

The username to log on to the telnet server.

Password

The password for the telnet server.

Login Process

Write the logon output followed by #. This must then be followed by the password output, followed by #. If there is any new output between the password output and the prompt, add that output followed by #.


For example:

Telnet Login

Login Process (2)

login: admin1


loginack
passw: ******


pswack


<

log in:#passw:#pswack#. (3)

Prompt

The prompt output on the telnet server, for example, <.

Response Timeout (ms)

Time in milliseconds to wait for a response after sending a request.


Value range: 0300000


Default value: 11000(4)

Connection Timeout (ms)

Time in milliseconds to wait for a connection attempt to get contact before the attempt is aborted.


Value range: 0300000


Default value: 11000

Number of Retries

Number of times that connection is retried, if detected telnet busy failure.


Value range: 010


Default value: 3

Function Busy Timer (ms)

After receiving a Function Busy response from the telnet server, this parameter determines how long to wait before trying again. The unit is milliseconds.


Value range: 060000


Default value: 1000

Retry Factor

After receiving a Function Busy response from the telnet server, Retry Factor together with Number of Retries and Function Busy Timer determines how long to wait before a next try.


Value range: ≥ 1


Default value: 2

Long Retry Time Interval (ms)

After receiving a broken connection from the HLR, this parameter determines how long to wait before trying again.


Value range: 0180000


Default value: 15000

(1)  IPv6 is not valid for Native and CEE deployments.

(2)  If using an APG43L, the Login Process is either login:##Password:##, or login:#Password:

(3)  The "." at the end of the line is mandatory. The Dynamic Activation cannot log in to the HLR-FE node/s if the "." is missing.

(4)  The default value is based on the Open Shortest Path First (OSPF) dead time-out to avoid premature failover or blacklisting.


8.3.1.7.3   SSH Connection Protocol Parameters

The following table shows more SSH connection protocol parameters.

Table 10    SSH Connection Protocol Parameters

Parameter

Description

Host

IPv4/IPv6(1) address or hostname.


The host containing the SSH server.

Port

Defines to which port SSH listens.


Value range: 165535

username

The username to log on to the SSH server.

Password

The password for the SSH server.

Private Key

The Private Key for SSH communication with SSH server. Public key is used to authenticate with external SSH server, and Public Key is created based on the Private Key. Private Keys must not be shared with the external SSH server.

Login Process

Write the logon output followed by #. This must then be followed by the password output, followed by #. If there is any new output between the password output and the prompt, add that output followed by #.


For example:

SSH logon

Login Process

login: admin1


loginack
passw: ******


pswack


<

login:#passw:#pswack#. (2)

App username

The application username for logon procedure.

These attributes are used for IPWorks only.

App Password

The application user password for logon procedure.

App Command

The application initiating or starting up command.

App Login Procedure Prompt

The displayed prompt the application print during the logon procedure.


For example:

SSH logon

Login Process

$ ssh –l actadm <IP address of IPWorks>


Password:


Last login: Thu Jul 2 10:00:00 2015 from <IP address of the login user>


$ ipwcli


IPWorks>Login: admin


IPWorks>Password: *********


Login to server successful.

Last login#IPWorks> Login:#IPWorks> Password:#Login to server successful

Line Termination Character

The Line Termination Character of application commands output during the command interaction.


Default value: \n

Prompt

The prompt output on the SSH server, for example, <.

Response Timeout (ms)

Time in milliseconds to wait for a response after sending a request.


Value range: 0300000


Default value: 11000 (3)

Connection Timeout (ms)

Time in milliseconds to wait for a connection attempt to get contact before the attempt is aborted.


Value range: 0300000


Default value: 11000

Number of Retries

Number of times that connection is retried, in case of detected SSH busy failure.


Value range: 010


Default value: 3

Function Busy Timer (ms)

After receiving a Function Busy response from the SSH server, this parameter determines how long to wait before trying again. The unit is milliseconds.


Value range: 060000


Default value: 1000

Retry Factor

After receiving a Function Busy response from the SSH server, Retry Factor, Number of Retries, and Function Busy Timer determine how long to wait before a retry.


Value range: ≥>= 1


Default value: 2

Long Retry Time Interval (ms)

After receiving a broken connection from the NE, this parameter determines how long to wait before trying again.


The optimal value can be different for different NEs.


Value range: 0180000


Default value: 15000

(1)  IPv6 is not valid for Native and CEE deployments.

(2)  The "." at the end of the line is mandatory. The Dynamic Activation cannot log on to the HLR-FE node/s if the "." is missing.

(3)  The default value is based on the Open Shortest Path First (OSPF) dead time-out to avoid premature failover or blacklisting.


8.3.1.7.4   Provisioning Notification Protocol Parameters

Provisioning Notification is a module used for notifying front ends after successful provisioning to CUDB.

The Provisioning Notification module uses SOAP over HTTP as protocol and the following table show more connection protocol parameters.

Table 11    Provisioning Notification Protocol Parameters

Parameter

Description

The end point URL for the notification service

The URL endpoint syntax is as follows:


http://<IPv4 address, IPv6 address, or hostname>:<port number>/<service> (1)(2)


The following are URL examples for IMS and EPS:


http://<HSS_OAM_VIP>:<Configured_Port_x>/HssIsmSdaUdcWS/services/NotificationService
http://<HSS_OAM_VIP>:<Configured_Port_y>/HssEsmUdcWS/services/NotificationService


Where:


<HSS_OAM_VIP> – Can be a hostname or an IPv4/IPv6 address. (1) .


<Configured_Port_n> – Can be obtained from the configurable attributes of the HSS node:


  • In case of HSS-FE, the attributes are hss-SoapNotificationsPort for IMS provisioning, and hss-EsmSoapNotificationsPort for EPS provisioning.

  • In case of HSS/SLF, the attributes are HSS-SoapNotificationsPort for IMS provisioning, and HSS-EsmSoapNotificationsPort for EPS provisioning.

The end point URL for the heartbeat procedure

The URL endpoint syntax is as follows:


http://<IPv4 address, IPv6 address, or hostname>:<port number>/<service>?wsdl(1) (2).


Note: wsdl file is downloaded for each heartbeat attempt.


The following are URL examples for IMS and EPS:


http://<HSS_OAM_VIP>:<Configured_Port_x>/HssIsmSdaUdcWS/services/NotificationService?wsdl
http://<HSS_OAM_VIP>:<Configured_Port_y>/HssEsmUdcWS/services/NotificationService?wsdl


Where:


<HSS_OAM_VIP> – Can be a hostname or an IPv4/IPv6 address. (1) .


<Configured_Port_n> – Can be obtained from the configurable attributes of the HSS node:


  • In case of HSS-FE, the attributes are hss-SoapNotificationsPort for IMS provisioning, and hss-EsmSoapNotificationsPort for EPS provisioning.

  • In case of HSS/SLF, the attributes are HSS-SoapNotificationsPort for IMS provisioning, and HSS-EsmSoapNotificationsPort for EPS provisioning.

The number of attempts to resend in case of a connection level error

Number of times that the connection is retried when connection error occurs.


Value range: 010


Default value: 3

The interval (ms) between the retry attempts

The waiting time between retries for connection,


Value range: 060000


Default value: 1000

(1)  IPv6 is not valid for Native and CEE deployments. The IPv6 address needs to be specified within brackets [IPv6 address].

(2)  IP address and port number must be the same for the end-point URL for the notification service and the end-point URL for the heartbeat procedure.


8.3.1.7.5   CAI3G Connection Protocol Parameters

The following table shows more CAI3G connection protocol parameters.

Table 12    CAI3G Connection Protocol Parameters

Parameter

Description

SSL/TLS

If checked, SSL/TLS is used as the lower-level protocol.


By default using HTTP as low-level protocol.

Request Traffic URL

A full URL used for sending requests.


The URL syntax is as follows:


http://<IPv4 address, IPv6 address, or hostname>:<port number>/<service> (1)

Heartbeat URL

A full URL used for sending heartbeat requests.


The URL syntax is follows:
<Request Traffic URL>/CAI3G?wsdl


If the Heartbeat URL is not configured, the status of the NE is Up.

The User ID to use for CAI3G Login

Username for the Login request.

The Password to use for CAI3G Login

Password for the Login request.

Number of Retries

Number of times that connection is retried, in case of detected function busy failure.


Value range: 0–10.


Default value: 3

Retry Time Interval (ms)

After receiving the function busy response from server, this parameter determines how long to wait before trying again. The unit is milliseconds.


Value range: 0–60000


Default value: 1000

Session Control URL(2)

A full URL used for sending session control requests (logon or logout).


The URL syntax is the same as the one for Request Traffic URL.


This URL can be the same as Request Traffic URL, or a different URL can be used.

WS-Security Mode (2)

WS-Security authentication for the subscription request.


It provides a UsernameToken as a means of identifying the request by username, and optionally using a password (or public key, or password equivalent) to authenticate that identity to the web service producer.

authentication username / password text(3)

UsernameToken and password are in plain text

authentication username / password digest (3)

UsernameToken and password are in the format of digest.


A digest password is produced by hash method by a given username, realm, and password.

Carry LogId

Request carries the Log ID of the local Dynamic Activation in the SOAP header to the remote CAI3G server.

(1)  IPv6 is not valid for Native and CEE deployments. The IPv6 address needs to be specified within brackets [IPv6 address].

(2)  The Session Control URL and WS-Security Mode are alternative parameters. When the WS-Security Mode is selected, Session Control URL cannot be specified.

(3)  The authentication format of WS-Security, which can be set only when the WS-Security mode is selected.


8.3.1.7.6   HTTP Connection Protocol Parameters

The following table shows more HTTP connection protocol parameters.

Table 13    HTTP Connection Protocol Parameters

Parameter

Description

Host

The IPV4/IPv6(1) address or hostname

Port

The port to which HTTP listens


Value range: 1–65,535

Agent

The HTTP agent name

The URI used to test the connectivity

The URI to test the connectivity between Dynamic Activation and NE nodes.


For example, up/UnifiedProvisioningService

Content Encoding

The content encoding


Value range: enumeration value="deflate", "gzip", "none"


For example: none

Secure

Support for security consideration

CA(2) used to validate server

Trust store for the validation of the server certificate.

CA (2) file password

The password of the trust store.

Mutual authentication (Two-way handshake)

Indicates whether the connection needs two-way SSL.

Client certificate used in mutual authentication

The key store contains client certificate.

Client certificate file password

The password of the Key Store P12 file is supported.

Authentication Method

The method of Authentication


Value range: enumeration value="basic", "none"


For example: none

HTTP Username

The username to log onto the http server

HTTP Password

The password to log onto the http server

Customized Heartbeat

Support for HTTP post heartbeat

HTTP Post Body

HTTP post request body

(1)  IPv6 is not valid for Native and CEE deployments.

(2)  Certificate Authority


8.3.1.7.7   CF-SSH Connection Protocol Parameters

The following table shows more CF-SSH connection protocol parameters.

Table 14    CF-SSH Connection Protocol Parameters

Parameter

Description

Host

IPv4/IPv6(1) address or hostname.


The host containing the SSH server.

Port

Defines to which port SSH listens.


Value range:  165535.


Default value: 22

username

The username to log on to the SSH server.

Password

The password for the SSH server.

Key

The Private Key for SSH communication with SSH server. Public key is used to authenticate with external SSH server, and Public Key is created based on the Private Key.


Private Keys must not be shared with the external SSH server.

Subsystem

Key for the term environment variable. If not set, vt100 is used.

Version of NE

The version of the data source, configured in the JDV.


The CF-SSH connector is only applicable for ENUM/IPWorks functionality, and the version to use can be found in Configuration Manual for Subscriber Activation, Reference [2].

Prompt

The prompt output on the SSH server, for example, >.


Default value: >

Line Termination Character

The Line Termination Character of application commands output during the command interaction.


Default value:  \n

Response Timeout (ms)

Time in milliseconds to wait for a response after sending a request.


Value range: 1300000.


Default value: 11000 (2).

Connection Timeout (ms)

Time in milliseconds to wait for a connection attempt to get contact before the attempt is aborted.


Value range: 1300000.


Default value: 11000

Number of Retries

Number of times that connection is retried, in case of detected SSH busy failure.


Value range: 010.


Default value: 3

Retry Factor

After receiving a Function Busy response from the SSH server, Retry Factor together with Number of Retries, and Function Busy Timer determines how long to wait before a retry.


Value range: ≥1.


Default value: 2

Long Retry Time Interval (ms)

After receiving a broken connection from the remote node, this parameter determines how long to wait before trying again.


Value range: 0180000


Default value: 15000

App username

The application username for logon procedure.

App Password

The application user password for logon procedure.

App Command

The application initiating or starting up command.

App Login Procedure Prompt

The displayed prompt that the application is printing during the logon procedure.


For example:

SSH logon

Login Process

$ ssh –l actadm <IP address>


Password:


Last login: Thu Jul 2 10:00:00 2015 from <IP address of the login user>


$ ipwcli


Prompt>Login: admin


Prompt>Password: *********


Login to server successful.

Last login#Prompt>Login:#Prompt>Password:#Login to server successful

(1)  IPv6 is not valid for Native and CEE deployments.

(2)  The default value is based on the Open Shortest Path First (OSPF) dead time-out, to avoid premature failover or blacklisting.


8.3.1.7.8   DNS Connection Protocol Parameters

The following table shows more DNS connection protocol parameters.

Table 15    DNS Connection Protocol Parameters

Parameter

Description

Domain

The domain used to resolve user account information.

Name Servers

IPv4/IPv6(1) address or hostname of name server. .

Response Timeout (ms)

Defines how long (in milliseconds) Dynamic Activation waits for a response from the NE before it times out.


Value range: 0 to 99999999.


Default value: 60000

(1)  IPv6 is not valid for Native and CEE deployments.


8.3.1.7.9   CF-HTTP Connection Protocol Parameters

The following table shows more CF-HTTP connection protocol parameters.

Table 16    CF-HTTP Connection Protocol Parameters

Parameter

Description

Host

The IPV4/IPv6(1) address or hostname

Port

The port to which HTTP listens


Value range: 1–65,535

Auth username

The username of basic access authentication

Auth password

The password of basic access authentication

Base Uri

The base URI of REST


For example, /provisioning/v1

HeartBeat Uri

The URI to perform heart beat (HTTP GET).


For example, /provisioning/v1/dataplans/global

HeartBeat accepted response code

The accepted HTTP status code from heartbeat


Default value: 201,404,414,500

Secure

Indicates whether to use secure communication (HTTPS)


Default value: false

Key store file

The key store that contains client certificate.

Key store file password

The password of the Key Store P12 file that is supported

Mutual authentication

Indicates whether the mutual authentication (two-way hand shake) is allowed


Default value: false

Trust store file

The trust store for the validation of the server certificate

Trust store file password

The password of the trust store

Version of NE

The version of the data source, configured in the JDV.


The CF-HTTP connector can be used for:


  • Monolithic SAPC 17A. The value is 17.

  • SAPC 1 and later versions for both Monolithic and Layered SAPC. For example, the value is 1.

(1)  IPv6 is not valid for Native and CEE deployments.


8.3.1.7.10   AIR-Connector Connection Protocol Parameters

The following table shows more AIR-Connector connection protocol parameters.

Table 17    AIR-Connector Connection Protocol Parameters

Parameter

Description

Host

The IPV4/IPv6(1) address or hostname

Port

The port to which HTTP listens


Value range: 1–65,535

Agent

The HTTP agent name

Auth user name

The username of basic access authentication

Auth password

The password of basic access authentication

Base Uri

The base URI of REST


The final URI format for AIR provisioning is <Base URI><Provisioning URI>


The <Provisioning URI> is an activation logic property. For detailed information, refer to Section 8.2.1.1.


For example, if Base URI is /CS and Provisioning URI is /Air, the endpoint of AIR provisioning is <Host>:<Port>/CS/Air

HeartBeat Uri

The URI to perform heart beat (HTTP POST).


The final URI format for heart beat is <Heartbeat URI>


For example, if Heartbeat URI is /CS, the endpoint of heart beat is <Host>:<Port>/CS

HeartBeat Post Body

The HTTP body to perform heart beat (HTTP POST).


For example, <methodCall><methodName>GetCapabilities</methodName><params><param><value><struct></struct></value></param></params></methodCall>

HeartBeat accepted response code

The accepted HTTP status code from heartbeat


Default value: 201,404,414,500

Secure

Indicates whether to use secure communication (HTTPS)


Default value: false

Key store file

The key store that contains client certificate.

Key store file password

The password of the Key Store file that is supported

Mutual authentication

Indicates whether the mutual authentication (two-way hand shake) is allowed


Default value: false

Trust store file

The trust store for the validation of the server certificate

Trust store file password

The password of the trust store

Version of NE

The version of the data source, configured in the JDV.


The AIR connector can be used for AIR version CS6, CS16 and CS17.

(1)  IPv6 is not valid for Native and CEE deployments.


8.3.2   Network Element Groups

From the Network Element Groups it is possible to administer routing to NE type, see Figure 17. To upload the default NE groups, refer to System Administrators Guide for Native Deployment, Reference [5]

Figure 17   Network Element Groups Window

In Network Elements Groups, a table displays all configured NE groups. It shows the group name, the group type, the Network Elements Type, and the group status. It is possible to Add, View, Edit, and Remove routing for NE types by clicking appropriate icons. It is also possible to add or remove NEs from NE groups.

8.3.2.1   Adding a Network Element Group

New groups can be created, although this can be unnecessary. To add a new group, complete the following steps. For information about the parameters to be specified, see Table 18.

  1. Click Add.
  2. In Network Element Groups - Add - Step 1 / 2, type the group name and select the group type. Click Next.
  3. In Network Element Groups - Add - Step 2 / 2, select the NEs to include in the group. For Round-Robin, assign Weight, for Failover assign Order to the selected NEs.
  4. Click Apply.

    An Add operation successful page is displayed. The page shows all the parameters defined for the NE group. Users can continue to change the parameters as needed by clicking the appropriate icons. If the parameters are set correctly, click Done.

8.3.2.2   Editing a Network Element Group

Users can add NEs to or remove NEs from a Network Element group.

To edit a Network Element Group, follow these steps:

  1. Click the change icon for the group to modify.

    A page with General and Network Elements tabs is shown.

  2. To add or remove NEs, go to the Network Elements tab and change the settings as desired.
  3. Click Apply.

8.3.2.3   Removing a Network Element Group

Note:  
Before removing the NE Group, remove all the NEs from the group.

To remove a Network Element Group, follow these steps:

  1. Click the remove icon for the Network Element Group.

    A window opens to confirm the remove operation.

  2. Click OK.

8.3.2.4   Network Element Group Parameters

A Network Element Group is defined by the following parameters.

Table 18    Network Element Group Parameters

Parameter

Description

Name

The name for the NE group.

Group Type

The algorithm that is to be used by the group to distribute the requests between the NEs in the group. The possible choices are Round Robin and Failover.


Note: This parameter can only be set during creation of the group. The only way to change the type of a group is to delete it and recreate it again with the correct type.


Round Robin - A load sharing algorithm that distributes the requests among all the available NEs according to their weight factor (see parameter Weight).


Failover - An algorithm that always sends the requests to a primary NE as long as it is available. If the primary NE is not available, the group can have multiple stand-by NEs. The Order parameter decides in which order the NEs must be chosen (see parameter Order).


Active-Active – An algorithm that sends the requests to all active NEs in the group and is only supported by NE type AAA_FE_NSD.

Status

The status for an NE group.


OK = All NEs belonging to this group are working properly.


Empty = This group has no NEs.


All Blacklisted = All NEs connected to this Group are unusable. Check the NEs for alarms to identify what is wrong. Once the faulty NEs can be used again, the group status automatically changes.


Partly Blacklisted = At least one of the NEs belonging to this group is unusable. Go to the Network Elements tab to see which NEs are down. Check the NEs for alarms to identify what is wrong. Once the faulty NEs can be used again, the group status automatically changes.

NE Type

The NE type to which the NE group belongs to, see Configuration Manual for Subscriber Activation, Reference [2].

Weight

For the Round-Robin distribution type, the weight factor is used to balance the load among NEs in an NE group. For example, if there are three active NEs with weight factors 1, 4 and 5, the data is distributed as follows:


  • 10% (1/10) for the first NE

  • 40% (4/10) for the second NE

  • 50% (5/10) for the third NE


Value range: 1100

Order

For the Failover group type, the order number is used to decide in which order the group must try the different NEs.


A Failover group always choose the NE that is available (Status is Up) and has the lowest order to handle the request.

8.3.3   Routing

From Routing it is possible to administer relations between NE and NE Types and Routing Methods, see Figure 18. To configure the default NE routing methods, refer to System Administrators Guide for Native Deployment, Reference [5].

Figure 18   Routing Window

In Routing window, a table displays Network Element Types and their respective Routing Method. Operators can Add, View, Edit, and Remove routing for Network Element Types by clicking appropriate icons.

Note:  
When configuring Routing for IPWorks/ENUM provisioning, Dynamic Activation can be configured to provision either layered or monolithic IPWorks/ENUM, not both of them at the same time. For more information, refer to Configuration Manual for Resource Activation, Reference [2].

8.3.3.1   Adding a Routing

To add and configure a routing, follow these steps:

  1. Click Add.
  2. In the Routing - Add - Step 1 / 3, General menu, choose Network Element Type from the drop-down list.
  3. Click Next.
  4. In the Routing - Add - Step 2 / 3, Network Elements menu, if any NE, NE Groups, or Cluster Strategies are configured, select the <NE Group> as Available Network Element Group(s) or <Cluster Strategy> as Available Cluster Strategy(s) to the corresponding <NE Type>.
  5. In Routing - Add - Step 3 / 3, operators can select routing method and edit routing items for selected managed object.
    1. Select a routing method from the drop-down list for selected managed object:
      • Number Range Routing
      • Number Series Routing
      • Regular Expression Routing
      • Unconditional Routing

      The detailed routing item parameters are changed according to method selection. Operators can have several routing items in the list.

    2. Configure the routing information for the chosen method.
      • Number Range Routing
        1. Select a Network Element (Group) and Attribute Name.
        2. Specify the start range and stop range.
        3. Click Add.
        4. Repeat the previous steps for more routing items.
        5. Click Apply to finish adding rules. A verification page is displayed.
        6. Click Change This... to change the configured routing rules.
        7. Click Done.
      • Number Series Routing
        1. Select a Network Element (Group) and Attribute Name.
        2. Specify the number series in the Series field.
        3. Click Add.
        4. Repeat the previous steps for more routing rules.
        5. Click Apply to finish adding rules. A verification page is displayed.
        6. Click Change This... to change the configured routing rules.
        7. Click Done.
      • Regular Expression Routing
        1. Select a Network Element (Group) and specify an Attribute Name.
        2. Specify the expression in the Regular Expression field.

          Regular expression can be used to express number series and number ranges. The format is ^number[numbers][from number – to number]...\d*$ where ^ and $ quote the content of the definition, and \d* is the wildcard. For example, the expression ^46[379][2-8]\d*$ represents number ranges of 4632*-4638*, 4672*-4678* and 4692*-4698*.

          Note:  
          Characters "|" and ";" are not allowed in Regular Expression field, because they are used as separators in Regular Expression Routing configuration. For alternation constructs which uses "|" character to separate the alternatives, each alternative must be configured separately.

        3. Click Apply to finish adding algorithm rules. A verification page is displayed.
        4. Click Change This... to change the configured routing rules.
        5. Click Done.
      • Unconditional Routing
        1. Select the Network Element (Group) to which all requests are directed.
        2. Click Apply.
        3. Click Change This... to change the configured routing rules.
        4. Click Done.

8.3.3.2   Editing a Routing

Users can edit a routing by changing the routing methods, editing related Network Element (Group), attribute type and specific algorithm parameters.

To edit a routing, follow these steps:

  1. Click the change icon for the routing to modify.

    A page with General, Network Elements, and Routing Details tabs is shown.

  2. In the General tab, change the managed object, if needed.
  3. In the Network Elements tab, add or remove Available Network Element Group(s) or Available Cluster Strategy(s), if needed.
  4. To change the routing methods, go to the Routing Details tab and change the settings as desired. For information about how to set the routing method, see Step 5 in Section 8.3.3.1.
  5. Click Apply.

8.3.3.3   Removing a Routing

Note:  
Before removing a Routing, remove all the NE Groups from the Routing.

To remove a routing, follow these steps:

  1. Click the remove icon for the routing.

    A window opens to confirm the remove operation.

  2. Click OK.

8.3.3.4   Routing Parameters

A routing is defined by the following parameters.

Table 19    Routing Parameters

Parameter

Description

Network Element Type

The logical representation of an NE function

Network Element (Group)

Destination for a request which matches the routing algorithm rule

Routing Method

The type of routing method for the routing

Routing Items

A configuration item which contains match rules and destination for number ranges or series

Algorithm Rule

Routing method parameter for regular expression

8.4   System

This section covers the System tab in the Dynamic Activation GUI. It consists of the Licenses, Options, and Notification email configuration subtabs.

8.4.1   Licenses

In the Licenses tab, all licenses and PC keys existing in the system are presented. Operators can View and Update licenses, see Figure 19.

Figure 19   Example of Licenses Window

Table 20    Licenses Table Columns

Column

Description

License ID

The ID of the license

Name

The name of the license.

Type

The license type, can be Value package or PC license.

Capacity used

The capacity being consumed by the system.

Capacity

The capacity the system is entitled to.

Percent Used

A round indicator showing green up to 80% subscriber capacity used, yellow between 80% and 100% and red when exceeding 100%

Expiration Date

The date the license expires.

8.4.2   Options

In the Options tab operators can turn ON or OFF Alarm Supervision, set Maximum Consecutive Unsuccessful Login Attempts, turn ON or OFF Login Locking, configure different User Password Settings, set Target Pool Max, and turn ON or OFF CUDB Lookup, see Figure 20.

Figure 20   Options Window

Table 21    Options Configurations

Type

Configuration

Description

Alarm Configuration

Alarm Supervision

Turns all system SNMP alarms ON or OFF.

Login Authentication (1)

Maximal Consecutive Unsuccessful Login Attempts

Maximal number of consecutive unsuccessful login attempts. If this number is reached, the user is locked. If this number is exceeded, an event is sent.

Login Locking

Turns the Login Locking feature ON or OFF. If the feature is ON, and if wrong password is entered <number> times, the user is locked. Only the super user or user administrator can unlock a locked user.

User Password Settings (1)

Minimum Length

Range 4–32 characters.


Default value is 8.

Minimum Occurrence of Lower Case Characters

Range 0–32 characters.


Default value is 1.

Minimum Occurrence of Upper Case Characters

Range 0–32 characters.


Default value is 1.

Minimum Occurrence of Digits Characters

Range 0–32 characters.


Default value is 1.

Minimum Occurrence of Special Characters

Range 0–32 characters.


Default value is 1.


The following are considered as special characters: !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~

Core Properties

Target Pool Max

Defines the maximum number of internal threads for each Dynamic Activation node. The value on this parameter can have a large impact on system performance.

CAI3G corresponding to MML family

Enables or disables traffic for MOs of this type.


Default is disabled. (2)

Prevent Concurrent Subscriber Provisioning

Enables or disables the Prevent Concurrent Subscriber Provisioning feature.


It is used to prevent the concurrent provisioning to the same subscriber.


Default is disabled.

Administration of Multi-region (3)

CUDB Lookup

Enables or disables the CUDB Lookup feature.


The CUDB Lookup feature is used to find the Region Identifier (RID) value for a subscriber when either of following:


  • RID is not included in an incoming request.

  • There are no MSISDN rules defined in the Administration Domain.

(1)  For provisioning clients configuration.

(2)  These MOs are considered as deprecated and the recommendation is to avoid using them.

(3)  This property is license dependent.


8.4.3   Notification Email Configuration

In the Notification email Configuration tab operators add email addresses to where notifications are sent if the capacity license is exceeded, see Figure 21.

For more information, refer to information about Subscriber Licensing in Function Specification Resource Activation, Reference [4].

Figure 21   Notification email Configuration Window

The following tables describe the variables in the Notification email Configuration window.

Table 22    Email Address Configuration

Variable

Description

Mail From Address

The email address used as the sender of notification emails.

Mail To Address

The receiver of notification emails.


If several addresses are specified they must be separated with comma (,).

Table 23    SMTP Server Configuration

Variable

Description

SMTP Host

The SMTP hostname, fully qualified hostname, or IP address for the notification email address.


Upon successful account verification, a notification email is sent to the specified SMTP host.

SMTP Port Number

The SMTP port number used for the notification email address.

Use SMTP Authentication

A check box that defines if SMTP Authentication is used or not. Disabled by default.

SMTP username

The username for the SMTP server.

SMTP Password

The password for the username to the SMTP server.

8.4.4   Synchronize Configuration

Attention!

Synchronize Configuration can only be applied among clusters at the same software level.

Applying synchronization to a cluster at a different software level causes problems.

In this tab, it is possible to manually synchronize configuration from one cluster to one or two other clusters. During this process, configuration data from the cluster where Synchronize Configuration is executed on, is sent to one or two receiving clusters. The whole configuration of receiving clusters is to be replaced by the configuration data of the sending cluster.

All clusters that are used in a configuration synchronization need to be set up first. For more information about how to set up the clusters for synchronization, see System Administrators Guide for Native Deployment, Reference [5].

Figure 22   Synchronize Configuration Window

The Synchronize Configuration window displays a check box. If this check box is checked, parameters from access control are included in the synchronization of the configuration. If the check box is left empty, the configuration synchronization does not include any parameters from access control. For more information about parameters in access control, see Section 8.5. If parameters from access control are included in the configuration synchronization, performance of the receiving cluster can be affected.

Note:  
Before synchronizing the configuration, the traffic interface on all PL nodes on the receiving cluster must be disabled to avoid traffic disturbances. For more information about how to disable and enable traffic, see System Administrators Guide for Native Deployment, Reference [5].

When pressing Apply button, a message is displayed saying that synchronization is ongoing. This process can take several minutes depending on, for example, the number of NEs. If the configuration synchronization fails to one or both clusters, an error message is shown.

Caution!

Before pressing the Apply button, make sure to be logged in on the correct cluster, the one that contains the configuration to be sent for synchronization. If performed on the wrong cluster, this action can cause loss of configuration on active, provisioning cluster, and total stop of provisioning.

8.5   Access Control

The Access Control tab is used to manage and configure provisioning clients. It consists of the Users, Policies, Attribute Rules, and Administration Domains subtabs.

8.5.1   Users

Provisioning clients can be added, modified, and deleted in the Users tab, see Figure 23.

Figure 23   Users

8.5.1.1   Adding a Provisioning Client

To add a provisioning client (referred as a user), follow the instruction:

  1. In Users tab, click Add.

    The Users - Add - Step 1 / 3 shows as in Figure 24:

Figure 24   Users - Add - Step 1 / 3

A user is defined by the parameters described in Table 24.

By clicking Advanced, the two SSH related parameters are available: Max SSH sessions and SSH Public Key.

The two parameters only take effect when SSH CA project is deployed. For details, refer to Northbound Interface Adapter Customization Development Guide for CLI-Based Protocol, Reference [11].

Table 24    Users Parameters

Parameter

Description

Name

Name of the user


Mandatory


Username criteria:


  • A username must be within the regular expression; [a-zA-Z0-9]*.

  • A minimum of 1 character and a maximum of 32 characters.

  • No control or space characters.

Password

Password, used to access the user menu


Mandatory


Password criteria:


  • Contains only characters from the ISO-8859-1 character se. That is, the numbers from 0 through 9, the uppercase and lowercase English alphabet, and the following commonly used special characters: !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~

  • A minimum of 4 and a maximum of 32 characters

  • No control or space characters

Description

A short description of the user


Optional

Locked

Locking a user at this stage can be used in case the user needs to be locked until the system is properly configured

Max CAI3G sessions(1)

Fill in this Capacity Attribute text field to limit the number of CAI3G sessions for the user.


Value 0–25000


Default value for this parameter is 0 which means no limitations are enforced for the particular user.


Optional

Max CAI sessions (1)

Fill in this Capacity Attribute text field to limit the number of CAI sessions for the user.


Value 0–250


Default value for this parameter is 0 which means no limitations are enforced for the particular user.


Optional

Max MML sessions (1)

Fill in this Capacity Attribute text field to limit the number of MML sessions for the user.


Value 0–160


Default value for this parameter is 0 which means no limitations are enforced for the particular user.


Optional

Min HLR sustainable CSO/sec (1)

Fill in this Capacity Attribute text field to limit Customer Service Operations (CSOs) per second for the user.


Default value for this parameter is 0.0 which means no limitations are enforced for the particular user.


Optional

Max SSH Sessions

Fill in this Capacity Attribute text field to limit the number of SSH sessions for the user.


Value 0-250


Default value for this parameter is 0 which means no limitations are enforced for the particular user.


Optional


This parameter is only available in Advanced mode.

SSH Public Key

Public key for the user.


Optional


Public key criteria:


  • Match the regular expression: ^$|^((ssh-rsa|ssh-dss) .*)


Default value for this parameter is empty string which means SSH login is not supported.


This parameter is only available in Advanced mode.

(1)  This parameter is available when the Administration of Multi-region >CUDB Lookup: property is enabled, see Section 8.4.2


  1. Fill in the mandatory fields to create a User.

    When done, click Next.

    The Users - Add - Step 2 / 3 shows, as in Figure 25:

Figure 25   Users - Add - Step 2/ 3

  1. Select the Configuration Management Authorities for the user.
    • If selecting No authorities, the user has no access to the GUI.
    • If selecting Full authorities, the user is given Configuration Management Administrator Role and has full permissions.
    • If selecting Customize authorities, it is possible to select roles manually for the user. A user can have more than one role.

    When selection is done, click Next.

    The Users - Add - Step 3/3 shows, as in Figure 26:

Figure 26   Users - Add - Step 3 / 3

  1. Select the Provisioning Authorities for the user.
    • If selecting No authorities, the user has no provisioning authorities.
    • If selecting Full authorities, the user is given full provisioning authorities.
    • If selecting Customize authorities, it is possible to select Domain manually, Network Element, Managed Object, and Operations for the user.

    When selection is done, click Apply.

Note:  
The Policies must be updated to activate the changes made. See Section 8.5.2.

8.5.1.2   Editing a Provisioning Client

Provisioning clients can be edited by changing password, description, locked-status, authorities, and related Administration Domains.

To edit a provisioning client (referred as a user), follow these steps:

  1. In Users tab, click the change icon for the user to modify.

    A page with General, Configuration Management Authorities - Authority Level/Roles , Provisioning Authorities - Authority Level and Administration Domains tabs is shown, see Figure 27.

Figure 27   Users - Change

  1. In the General tab, it is possible to change Password, Description, Locked - status and change the number of Max CAI3G sessions, Max CAI sessions, Max MML sessions, and Max SSH sessions as well as set Min HLR sustainable CSO/sec and SSH Public Key.

    Click Advanced to edit the values of the parameters Max SSH sessions and SSH Public Key.

Note:  
It is not possible to change the name of the User.

  1. In the Configuration Management Authorities - Authority Level/Roles tab, it is possible to change the Configuration Management Authorities for the specific user.
  2. In the Provisioning Authorities - Authority Level tab, it is possible to change the Provisioning Authorities for the specific user.
  3. In the Administration Domains tab, it is possible to change (assign or remove) Domains for the specific user.
    Note:  
    A user that is created does not get a default Administration Domains role. If a user must have an Administration Domains role assigned, it is made afterwards.

  4. Click Apply.
Note:  
The Policies must be updated to activate the changes made. See Section 8.5.2.

8.5.2   Policies

In the Policies tab, click Apply to activate changes made in the Users, Attribute Rules, and Administration Domains tabs.

Note:  
Updating policies can have a temporary impact on the system performance. It is therefore wise to update policies during off-peak hours.

8.5.3   Attribute Rules - Restriction Rules

In the Attribute Rule tab, it is possible to set or change restriction rules on attribute level for a specific user. These attribute rules are checked for incoming requests. It is not possible to restrict the response that is to be returned.

Note:  
The user must have Provisioning Authorities set to Customize authorities to be able to use the Attribute Rule function.

Figure 28 shows the users that already have restriction rules set on attribute level. It is possible to use appropriate icon to:

Figure 28   Attribute Rule

Click Add in the Attribute Rule window.

The Attribute Rule-Add-Step 1 / 2 window is displayed, as in Figure 29.

Figure 29   Attribute Rule - Add-Step 1 / 2

The users that have been defined in the system, but have no restriction rules, are visible in the Users Without Rules scrollbar.

Click Next to set the restriction rules for the selected user.

In the Attribute Rule - Add-Step 2 / 2 window, add the wanted restriction rule on attribute level, as shown in Figure 30.

Figure 30   Attribute Rule - Add- Step 2 / 2

When an attribute is selected, the operator that can be used for that type of attribute is shown in the Operator scrollbar.

The Value must be specified according to the interface specifications, see chapter Interface, in the Library Overview, Reference [1] document.

To add a logical AND between two conditions (or more), select two rows (or more) and click AND.

To add a logical OR between conditions, leave the conditions on separate rows. An OR is added between the rows in the Current Rule window.

A condition that is based on an attribute not included in the incoming request is evaluated to:

The Condition View shows how the condition is built up.

It is possible to split a condition containing one or more AND operators by selecting a row and then clicking Split.

Removing a row is done by clicking Remove.

Click Apply to activate the restriction rule made.

Note:  
The Policies must be updated to activate the changes made. See Section 8.5.2.

To modify the current rule, change values for an attribute under the Edit View. This option updates the selected rules with the values entered in the operator.

8.5.4   Administration Domains

The Administration Domains tab is available when adequate license is obtained.

In the Administration Domains tab Administration Domains can be added, modified, or changed. It is also possible to add, edit, view details or delete rules on attribute level for a specific Administration Domains role.

Note:  
This feature is only supported for HLR and M2M in the data layered architecture.

Figure 31 shows the existing Administration Domains.

Figure 31   Administration Domains

To compare values for two different Administration Domains, fill in check boxes on the left from the Domains to be compared and click Compare. The Administration Domains - Compare - <Domain name 1>, <Domain name 2> window is displayed, as shown in Figure 32.

Figure 32   Compare Window

It is also possible to edit values for each compared domain by clicking Change <Domain name> button. For more information on how to edit Administration Domains, see Section 8.5.4.2.

8.5.4.1   Adding Administration Domains

To add Administration Domains, follow the instruction:

  1. Click Add in the Administration Domains window.

    The Administration Domains - Add-Step 1 / 2 window is displayed, as shown in Figure 33.

Figure 33   Administration Domains - Add-Step 1 / 2

Administration Domains are defined by the parameters described in Table 25.

Table 25    Administration Domains Parameters

Parameter

Description

Name

Name of the administration domain


Allowed characters are a-z, A-Z, 0–9, -, _ and whitespace.


Mandatory

Description

A short description of the administration domain


Optional

Sysadm

Enable this check box to make the domain a System Administrator Administration Domain. A user that has such domain assigned as a role is able to run conditional searches via CLI interface towards all existing domains with higher performance.(1)


Optional

Add RID to Subscriber Profile

The Subscriber Profile Ranges, CAMEL Profile Ranges, and GPRS Profile Ranges have been extended for Multi Region feature and Logical HLR feature in HLR. Subscriber Profile Range is extended from 256 profiles to 8192 (32*256) profiles and CAMEL/GPRS Profile Range is extended from 255 profiles to 8160 (32*255) profiles.


The CAS system must include the real profile value in the provisioning request towards Dynamic Activation for CAMEL or GPRS profiles.


The CAS system can use the range 0–255 (256 profiles) in the provisioning request towards Dynamic Activation for Subscriber Profiles, but the Add RID to Subscriber Profile check box must be enabled. Then the HLR-FE internally uses the RID and Subscriber Profile to calculate the real Subscriber Profile value.


Optional

Min HLR sustainable CSO/sec

Fill in this Capacity Attribute text field to limit Customer Service Operations (CSOs) per second for the role.


Default value for this parameter is 0.0 which means no limitations are enforced for the particular user.


Optional

(1)  For a domain with Sysadm flag checked, do NOT set any restriction rules as this domain is meant to have no restrictions.


  1. Fill in the mandatory fields to create an Administration Domain.

    Click Next to set the attribute rules for the added Administration Domains.

  1. In the Administration Domains - Add-Step 2 / 2 window, add the wanted rules on attribute level, as shown in Figure 34.

Figure 34   Administration Domains - Add- Step 2 / 2

  1. The rid and the imsi attributes are mandatory and must always be defined for every Administration Domain.

    Warning is given if RID or IMSI be undefined, see Figure 34.

    Overlapping of RID, IMSI, and MSISDN between Domains is notified with warning messages.

    The Value is to be specified according to the interface specifications, see chapter 2.3.7 Interface, in the Library Overview, Reference [1] document.

    Note:  
    Default behavior is AND between rows with different attributes. However, between rows with same attribute, for example, MSISDN, the default behavior is OR.

    To add a logical AND between two conditions (or more) for the same attribute, select two rows (or more) and click AND.

    To add a logical OR between conditions for the same attribute, leave the conditions on separate rows and click OR.

    It is possible to split a condition containing one or more AND operators by selecting a row and then clicking Split.

    Removing a row is done by clicking Remove.

    Administration Domains restriction rules are possible to define with:

    • Value ranges.
    • Series (that is value starts with a configured number, and allow any combination after the configured number.)
    • Regular expressions.
Note:  
The restriction rules are only checked for incoming requests. It is not possible to restrict the response that is to be returned.

  1. It is also possible for the user to define any SUD code and its value rule, both for value part 1 and value part 2, see Figure 35.

Figure 35   Administration Domains - Add- Step 2 / 2 SUD Codes

To add a new SUD Code for Standard HLR Subscriber, in the tree-view select Domain > Voice > HLR > HLR Subscription and sud, enable the Add New SUD Code check box, enter a unique SUD Code name, and specify the values for it.

  1. Click Apply.
  2. Click the View Details icon to validate the Administration Domains restriction rules made.

    If a SUD Code is added, details can be seen by clicking the View Details icon for the specific Administration Domain in the Administration Domains tab.

  1. Update the Policies.
    Note:  
    The Policies must be updated to activate the changes made. See Section 8.5.2.

8.5.4.2   Editing Administration Domains

To edit Administration Domains, follow the instruction:

  1. Click the change icon to change settings of the Administration Domain.
  2. The Administration Domains - Change - <Domain name> window with General and Rules is displayed.
    Note:  
    It is not possible to change the name of the Administration Domain.

  3. Click Apply to set the restriction rules for the Administration Domain.
  4. Update the Policies.
    Note:  
    The Policies must be updated to activate the changes made. See Section 8.5.2.

8.6   Walkthroughs Control

This section covers the Walkthroughs tab in the Dynamic Activation GUI.

This feature is only visible for the super user and the Configuration Management Administrator.

8.6.1   Initial Setup

Go to the Walkthroughs tab to access the available walkthroughs, see Figure 36. A walkthrough can help when configuring certain parts of the GUI.

Figure 36   Walkthroughs Window

Select a walkthrough. Edit the settings on the page that is displayed. When ready, click Next and a new page is displayed. The walkthrough automatically takes the user to every page necessary for the procedure related to the walkthrough.

9   Priority Configuration

The Priority Configuration GUI shown in Figure 37 manages priority rule to be applicable on both Asynchronous CAI3G request and Synchronous CAI3G request.

Figure 37   Priority Configuration GUI

In the Priority Configuration GUI:

9.1   Add or Edit a Priority Rule

To add a priority rule (edit has a similar operation):

In the Priority Configuration GUI

  1. Click to open the priority rule slide-in panel.

  2. Configure the priority rule condition according to the description in Table 26.
Table 26    Priority Rule Condition Fields

Field

Description

MOType

Specify the MOType of the Asynchronous CAI3G request or the Synchronous CAI3G request in this field.

XPath

Specify the XPath condition expression in this field. The expression can be defined base on the content of the CAI3G request; the expression must compliant with the XPath semantics. (1)


It is allowed to configure different priorities using different XPath with same MOType. When the CAI3G request is to be matched by multiple XPath conditions, Dynamic Activation only assigns the highest priority (see the description of Priority) of the matched XPaths to the CAI3G request.


For example:


The priority of XPath /root/* has been set to 2.
The priority of XPath //*[local-name() = 'root']//*[local-name() = 'abc'] has been set to 6.


The priority of XPath //* has been set to 5.


The request is granted priority 2 if XPath /root/* has been matched.

Priority

The priority of the expected asynchronous CAI3G request or the expected synchronous CAI3G request. If there is no priority configuration provided, the default priority for asynchronous CAI3G request is 5, and the default priority for synchronous request is 1.


Multiple rules can be assigned with the same priority.


Priority ranges: from 1 to 10 where 1 is the highest priority.

(1)   XPath, the XML Path Language, is a query language for selecting nodes from an XML document, refer to Reference [12] with the exception that “|” must be expressed as “or”.


  1. Click to apply the configuration.

9.2   Delete a Priority Rule

To delete a priority rule:

  1. Click the row of the priority rule to be deleted.
  2. Click and then click to confirm the deletion.

10   Retry Rule Configuration

Note:  
The Retry Rules Configuration for Processing Queues and for Request Management are similar.

In this chapter, Retry Rules Configuration for Request Management are described as an example.


Figure 38 shows the GUI used for configuring retry rules of sub-requests in Resource Queues. The provisioning requests are executed asynchronously, and unsuccessful ones are to retried according to the configured retry rules.

Figure 38   Retry Rule Configuration

By default, the Retry Rule Configuration displays all available target resources that Resource Queues are presenting. Users can choose to:

10.1   Create Retry Rule

It is possible to add a retry rule based on a copy of an existing rule. For more information, see Section 10.2.4.

To add a retry rule from scratch in the Retry Rule Configuration GUI:

  1. Click Create Retry Rule. This opens the Add Retry Rule dialog.

  2. Follow the instruction of GUI to configure the retry rule.
    Note:  
    • Rule name must be unique within one target resource.
    • If multiple retry rules have overlap conditions (Error code or Error message, or both), the rule with the highest priority in the target resource is applied to a sub-request.
    • Mark Subrequest as Expired can be applied only to asynchronous traffic.

  3. Click to apply the configuration.

10.2   Manage Retry Rules

In the Retry Rule Configuration, an expanded target resource lists all retry rules that are configured in the Resource Queue, as shown as in Figure 39.

Figure 39   Manage Retry Rules

The retry rules are listed in a priority order (1 is the highest priority). A rule applies to a sub-request if one or more conditions of the rule are met, and the rest of the rules with lower priorities are not to be evaluated.

Hovering the mouse over a retry rule highlights the rule and shows more management operations.

10.2.1   View Retry Rule Details

In an expanded target resource, click to view the details of a retry rule.

10.2.2   Change Retry Rule Priority

In an expanded target resource:

  1. Hover the mouse over the retry rule.
  2. Drag and drop this rule to change its priority.

10.2.3   Edit Retry Rule

In an expanded target resource:

  1. Hover the mouse over a retry rule, and click .

    This opens a slid-in panel Edit Retry Rule.

  2. Change the configuration of the retry rule. For more information, see Section 10.1.
    Note:  
    The Target Resource cannot be changed when editing a rule.

  3. Click to apply the change.

10.2.4   Copy Retry Rule

It is possible to copy a retry rule to another target resource.

In an expanded target resource:

  1. Hover the mouse over a retry rule, and click .

    This opens the Add Retry Rule dialog.

  2. Change the Target Resource to another target resource into which the retry rule is copied.
  3. If needed, change the configuration of the copy.
  4. Click to add the copy as a new retry rule.

10.2.5   Delete Retry Rule

In an expanded target resource:

  1. Hover the mouse over a retry rule, and click .
  2. Click OK to confirm the deletion.

11   Asynchronous Request Management

The Asynchronous Request Management GUI shown in Figure 40 browses the information of asynchronous CAI3G requests that have not been executed successfully.

Figure 40   Asynchronous Requests Management GUI

In the Asynchronous Requests Management GUI:

11.1   Search by Condition

To search the Asynchronous CAI3G Requests that have not been executed successfully:

  1. In the searching bar, enter the search condition according to Table 27.
Table 27    Search Condition Fields

Field

Description

start Firetime and end Firetime are used to specify the time range of the search scope.


If the start Firetime and end Firetime are both empty: the current time minus 30 mins is used as start FireTime. And the current time is used as end FireTime.


If the start Firetime is empty, the end Firetime minus 30 mins is used as start FireTime.


If the end Firetime is empty, the start Firetime plus 30 mins is used as end FireTime.

Specify the keyword of the search condition.


The search conditions are:


  • Message Id - specify the identity of the Asynchronous CAI3G request.

  • MoType - specify the MO Type of the asynchronous CAI3G request.

  • User - specify the username preformed the request.

  • Priority - specify the priority of the Asynchronous CAI3G request.

Specify the value of the search condition. The search condition does not work if the text field is empty.


Message Id and Priority support multiple entries separated by ",".

Select condition based on the status of the requests.


  • All: shows all the items of Asynchronous CAI3G requests that have not been executed successfully.

  • Pending: shows the items of Asynchronous CAI3G requests in pending status.

  • Executing: shows the items of Asynchronous CAI3G requests in executing status.

  • Failed: shows the items of the failed Asynchronous CAI3G requests.
    Only the requests failed within 24 hours can be searched.

  1. Click to perform the search.

11.2   View Details of the Search Result

To view the details of the search result:

Note:  
There is no detail for failed request. To check the details of the failed requests, refer to System Administrators Guide for Native Deployment, Reference [5].

  1. Click the row to be viewed, a slide-in panel is displayed to show details information.

    • Message Id – see Table 27.
    • Status – see Table 27.
    • MoType – see Table 27.
    • Receive Time – Indicates the time that the request has been received by system.
    • Fire Time – Indicates the scheduled execution time of the request.
    • Group – Indicates the Group ID of the request.
    • User – see Table 27.
    • Log Id – Indicates the Processing Log ID of the request.

11.3   Delete Pending Items

To delete one or more pending items:

11.3.1   Result of Delete Operation

A message that indicates the result of the delete operation shows on the top right corner of the window.

Figure 41   Return Message of Delete Operation

Table 28 lists all the possible messages.

Table 28    Result of Delete Operation

Message(1)

Description

Delete <n> pending jobs successfully.

Indicates all the selected pending items have been successfully deleted.


For example, Delete 7 pending jobs successfully.

Failed to delete pending jobs. Internal Server Error

Indicates that failed to delete any selected pending item.

Delete <total amount>-<n> of the pending jobs successfully, and skip <n> pending jobs.

Indicates that delete operation skips items that have been changed from pending to executing or other status during the deletion. The rest of the selected pending items have been successfully deleted.


For example, Delete 5 of the pending jobs successfully, and skip 2 pending jobs.

Failed to delete job <n>, and delete <m> pending jobs successfully.

Indicates that system catches an exception when deleting (n)th pending item. m items are deleted successfully, n-1-m items are skipped. And the delete operation is ended.


For example, Failed to delete job 5, and delete 3 pending jobs successfully.

(1)  n,m=1,2,3...


The pending item that successfully deleted on GUI is sent a notification to BSS. This notification can be searched in the related Processing Log by its message ID, see Section 16.

12   Request Management

The Request Management default GUI shown in Figure 42 provides visualized statistics of sub-requests in Resource Queues.

Figure 42   Request Management Default GUI

Area 1 provides search function to find all sub-requests that belong to one particular asynchronous request. This can be used for troubleshooting purpose. See Section 12.1.

In area 2, the line charts show the historical numbers of sub-requests over the latest 24 hours in all Resource Queues. Hover the mouse over the lines to see how many sub-requests there were at a certain time.

In area 3 and 4, the gauge graphs show the current statistics of the individual Resource Queues.

The Resource Queues include:

Figure 43 shows an example.

Figure 43   Resource Queue Statistics

Resource Queues that meet one or more of the following conditions are moved to area 3 from area 4 automatically:

Available operations are:

12.1   Search in Request Queues

Use the Message Id of an asynchronous request as a keyword for search, the Request Management GUI searches all Resource Queues in the Dynamic Activation, and lists all sub-requests that belong to the asynchronous request as a search result. Figure 44 shows an example.

Figure 44   Search in Request Queues

Area 1 lists the detail information of the asynchronous request, whose Message Id has been searched. Users can delete this request or view its log if necessary.

Area 2 lists all the sub-requests that belong to the asynchronous request and are still in the Resource Queues. The following operations can be performed if needed:

In area 2 and 3, use to sort the sub-request lists in ascending or descending order.

Area 3 lists all the sub-requests that belong to the asynchronous request and have been executed.

Click in area 4 to return to the default Request Management GUI.

12.2   Monitor and Manage Sub-requests

In the Request Management default GUI, click a gauge graph to show detail statistic or manage sub-requests in a chosen Resource Queue.

12.2.1   Monitoring Operations

The Request Management GUI provides filtering function for monitoring sub-requests that match certain criteria. Figure 45 shows an example.

Figure 45   Monitor Requests in a Resource Queue

Without a Selected Filter

When there is no filter selected, the sunburst chart center in area 1 shows the total number of sub-requests in the current queue.

When hovering the mouse over the sunburst chart, area 2 shows the filter that is using, and the number of filtered-out sub-requests.

With Selected Filters

To select a filter, click the sunburst chart at where the desired filter is using.
Multiple filters can be selected one by one.

When one or more filters are selected:

Remove a Selected Filter

To remove a filter, click of a desired filter in area 3.

12.2.2   View Details of a Sub-Request

Click a row in area 4 of Figure 45, a slide-in panel is displayed to show more details of the selected sub-request.

Figure 46 shows an example.

Figure 46   Sub-request Details Slide-In Panel

The following operations can be performed if necessary:

12.3   Reschedule Expired Sub-requests

The Request Management GUI allows scheduling retry jobs for expired sub-requests in a chosen Resource Queue, as shown in Figure 47.

Figure 47   Add Scheduled Retry Jobs

Multiple retry jobs can be scheduled, where:

12.3.1   Add a Scheduled Retry Job

  1. In the Request Management default GUI, choose a desired Resource Queue and click its gauge graph.

    This shows the scheduler field for the Resource Queue.

  2. Click to choose a date and time, and click .
  3. Click to add a scheduled job.

12.3.2   Manage Scheduled Retry Jobs

When hover the mouse on a scheduled job, the editor and deletion buttons are shown: .

Available operations are:

13   Processing Queue

Queued provisioning commands are executed in parallel for different subscribers, while in serials for the same subscriber. The Processing Queue GUI enables users to browse and manage sub-requests of these provisioning commands.

13.1   Browser Processing Queues

In Processing Queue default GUI, users can browse sub-requests per NE or NE group, or per cluster instance, and can sort the sub-requests by status, as shown in Figure 48.

Figure 48   Processing Queue

In Figure 48:

13.2   Manage Processing Queues

Either by using search function, or by clicking a column that represents a queue, the Processing Queue lists all sub-requests that meets the criteria. Figure 49 shows an example.

Note:  
When the web page is reloaded, it is refreshed with new data from the system.

Figure 49   Manage Sub-requests in Process Queues

In Figure 49:

13.2.1   Change Status for Selected Sub-requests

Users can change status for specific sub-requests among Queued, Paused, and Expired, or cancel the sub-requests.

To select sub-request(s) and change their status, do the following in the Results table in Figure 49.

  1. Tick the of one or more sub-requests to select them.
  2. In area 5 in Figure 49, do one of the followings:
    • Change status to Queued – Click to resend the sub-request to the queue.

      This also changes all the former sub-requests for the same subscriber to Queued status.

      When click on an Expired sub-request, all the sub-sequent requests for the same subscriber are changed to Paused status.

    • Change status to Paused – Click .

      This also changes all the sub-sequent requests for the same subscriber to Paused status.

    • Click to delete the sub-request if it is not ongoing.

      Ongoing sub-requests cannot be deleted.

13.2.2   Change Status for All Sub-requests

Users can change status in a bunch for all sub-requests which are listed in the Results table, as shown in Figure 50.

Figure 50   Change Status for All Sub-requests

To change status for all sub-requests in a bunch, click one of the following:

14   Dashboard

Dashboard shows provisioning performance in the last 36 hours. With the SW Advanced license, a seven days historical performance can be shown.

Note:  
The time displayed in the Dashboard refers to the server time instead of the local time.

14.1   General Settings

This section describes general settings in Dashboard.

14.1.1   Refresh Dashboard

Figure 51   Refresh Settings

14.1.2   Select Monitoring Period

Figure 52   Select Monitoring Period

There are two ways to select a time span of the monitoring period.

Note:  
If the end point is not Now, the Auto-refresh is disabled for the Dashboard.

14.1.3   Choose Widgets

Click and then choose desired widgets to display in Dashboard.

Figure 53   Change Widget Settings

14.1.4   View Statistics Details

14.1.5   Change Table Settings

Click the setting button over the table header to change table settings, for example :

Figure 54   Change Table Settings Example

14.2   Northbound Performance

Figure 55 shows the provisioning performance on the synchronous northbound interface.

Note:  
In the current release, only the synchronous interfaces are monitored.

Figure 55   Synchronous Northbound Performance

14.3   Southbound Performance

Figure 56 shows the southbound provisioning performance monitor of the Dashboard GUI. This monitor is displayed when the Southbound widgets are selected. For more information, see Section 14.1.3.

Figure 56   Southbound Performance Monitor

The southbound performance monitor has similar functions as the northbound one does, except:

For more information, see northbound performance monitor described in Section 14.2.

15   User Management

The User Management GUI is visible only for System Administrator users.

The default user admin (email admin@eda.com) is a System Administrator.

In this GUI, System Administrator users can create and manage GUI users as shown in Figure 57.

Figure 57   User Management

15.1   Create a User

To create a user, do the following:

  1. In the User Management GUI, click Create User.

  2. Enter the user information.
    • If First Name and Last Name are not defined, the user email will be shown on the top of the GUI after the user logs in.
    • When selecting the User Role:
      • System Administrator – A user that has access to the User Management GUI. Therefore s/he can create and manage other users.
      • System User – A user that can only view or edit her or his own user profile.
  3. Click Save to go to the next page to get a generated password for the user.

  4. Click to copy the newly generated password, and then manually send it to the user through an email.

    The user will be forced to change password after the first logon.

    Note:  
    Password rules to fulfill for a new password can be configured. For instructions, refer to:

  5. Click Back to return to the User Management GUI.

    The newly created user is listed in the Users table.

15.2   Edit a User

This section describes how to change a user profile.

To edit a user, do the following:

  1. In the User Management GUI, find the desired user to be edited.

    Filters can be enabled by clicking for a quick search.

  2. In the Users table, do one of the following to open the Edit User GUI.
    • Hover the mouse over the row of the user, and then click .
    • Click the user email to go to the User Details GUI, and then click Edit.

  3. Edit the user information as desired.
    Note:  
    Email cannot be edited. Delete the old email and create an one if desire to change.

  4. To create a password for the user, do the following:
    1. Click Generate, and confirm the operation.
      Note:  
      The password takes effect immediately, even before clicking Save.

    2. Click to copy the newly generated password, and then manually send it to the user through an email.

    The user will be forced to change password after the first logon.

    Note:  
    Password rules to fulfill for a new password can be configured. For instructions, refer to:

  5. Click Save to apply the change.

15.3   Unlock a User

A user is locked if there are too many invalid logon attempts.

When unlocking a user:

16   Log Management

From the Log Management link it is possible to retrieve processing log information about the provisioning traffic, see Figure 59.

To view processing logs, a search is to be done first, as described in Section 16.1. When the search is started, northbound requests are visible to the right. By clicking one of the requests, detailed information about the whole transaction is displayed. Also, a new button is displayed. This to be able to pause the current search to, for example click a specific log and see detailed information about it.

For supported Log Management search use cases, see Figure 58.

Figure 58   Log Management Search Use Cases

A general search rule is that the more specific the Time interval for the search is, the faster and more exact the result is to be.

The primary search functionality is determined by the given search input, which is prioritized in the following order:

  1. Instance
  2. Failed (successful unchecked)
  3. Time search

One search follows only one path (see Figure 58), and ends up in the user GUI.

The Table Settings is used to set column preferences of the search results. Available operations are:

The Go to page field is used to more easily navigate to a specific page.

Figure 59   Log Management First Page

The following table describes the parameters used for Log Management.

Table 29    Log Management Parameters

Parameters

Description

Instance

For CAI3G request:


Unique identifier, for example msisdn, imsi, context.


What identifier that is used as Instance depends on what is included in the MOId and also the context in the header of the request message. The MOId for a specific MO type can be found in the respective CAI3G interface specification.


For CAI request:


All parameters that have only one value are used as Instance except Subscriber Data (SUD) and Password (PWD). The parameters are separated by colon ":".


For MML request:


All parameters that have only one value are used as Instance except SUD. The parameters are separated by comma ",".


Note: It is possible to search for several parameters at once by enabling regular expression search (selecting the regex check box), and then use the regular expression.

Regex

Enables the possibility to run an instance search with regular expressions.


Select the check box Regex and type a valid regular expression, before performing a Search.


For example: <instanceType>=<instanceValue>|<instanceType>=<instanceValue>. This search returns anything that matches either the first or the second statement separated by the "|" operator.


Note: Regular expression syntax must be followed strictly. In the above example, spaces are not allowed before or after the "|" operator.


If an exact match search is required, leave the Regex check box unselected.

Start Time

The start date and time (Local time-zone for user). Limits the search to only return logs after specified time.


Only dates that contain logs can be selected in the pop-up dialog. It is also possible to select hour, minute, and second.


The Start Time can also be set manually.

End Time

The end date and time (Local time-zone for user). Limits the search to only return logs before specified time.


Only dates that contain logs can be selected in the pop-up dialog. It is also possible to select hour, minute, and second.


The End Time can also be set manually.

Successful

Checked if the search returns logs with status "successful".

Failed

Checked if the search returns logs with status "failed".

Response Code

If information is entered here, the search only returns logs of the specified response code.

User

If information is entered here, the search only returns logs of transactions initiated by the specified user. Multiple users can be used as search conditions.

Hostname

If information is entered here, the search only returns logs of requests that are processed on the specified node. Multiple nodes can be used as search conditions.

Managed Object

If information is entered here, the search only returns logs of the specified MO type. Multiple MO types can be used as search conditions.

Operation Type

If information is selected here, the search only returns logs of the specified operation type. Available operation types are GET, CREATE, SET, LOGIN, LOGOUT, DELETE, and All operations.

Results Per Page

Number of logs in the northbound result table. Available options are 10, 20, 50, and 100.

Max Results

Maximum number of logs to be fetched before terminating the search. Available options are 1000, 2000, 3000, 5000 and 10000.

Managed Object

Shows the MO type of the log.

Protocol

The protocol of in the specific request.

Hostname

The hostname of the node where the request is processed.

RootLogId

RootlogId identification of every log entry is a global unique with sublogId.


It consists of:


[Hostname][datetime][sequence number][protocol]


Example:


E7009C021F0A271410201537470018CAI3G1_2

Time

Time when the log was stored. (Presented as local time-zone of the Dynamic Activation cluster server)

Execute time

Total time of a complete Northbound or Southbound request.

Response Code

The response code received for the request.

Transaction Id

The transaction id for the specific request.

16.1   Invoke a Log Search

To invoke a log search, enter information for the required parameters in the search area, as visualized in Figure 59. Details of the parameters are described in Table 29. The search returns logs that match the entered information.

The Clear button erases the information entered in the search area.

The Pause button is used to pause the current search to, for example click a specific log and see detailed information about it.

16.2   Filter Search

Filtering on search results is only possible when the search is terminated, either by cancellation or completion.

The filtering functionality filters the northbound result table. Type free text in the filter field. It filters on all columns of the result table and northbound request and response. Examples of filter queries are msisdn=12345677 and SET.

16.3   Sort Search

Sorting on search results is only possible when the search is terminated, either by cancelation or completion.

The sorting functionality sorts the northbound result table. Click the arrows to the right of the parameter that the results are sorted by. For example, the following picture shows the result table sorted by instance.

16.4   Cancel Search

It is possible to cancel an ongoing search by pressing the Cancel button. The already found results are displayed on the screen until the user creates a search or refreshes the page.

16.5   View Detailed Northbound and Southbound Information

To be able to view detailed information about the log, it is necessary to have an ongoing or finished search.

As shown in Figure 60, the northbound and southbound requests are shown down at the left of the page. When pressing one of these requests, the information field on the upper left-hand side displays general information about the request. The right side of the page displays the full request and response.

Note:  
Because of limitations on the GUI component, the GUI is limited to show 1000 southbound operations at a time, it could be that the entire log with all its southbound operations is not shown.

If that is the case, to view the entire log, use the Admin Tool to export the time-span containing the log. And then search for the southbound operations within that time-span. For more information about the Admin Tool and the export function, see section Processing Log Admin Tool in System Administrators Guide for Native Deployment, Reference [5] document.


Figure 60   Northbound Information

17   Loose Error Handling Management

From the Loose Error Handling it is possible to define and configure the Loose Error Handling rules, see Figure 61.

Note:  
The Loose Error Handling GUI is only accessible for the account who has the System Integrator role, the default account is siadmin.

Figure 61   Loose Error Handling

When click the rule name, a Rule Detail window shows on the right of the front page. It displays the details of a rule and supports the action of edit, duplicate, delete.

Figure 62   Rule Detail

17.1   Rule Parameters

The following table describes the parameters for defining a rule.

Table 30    Rule Parameters

Parameters

Description

Name

Name of the rule, must be unique and fewer than 80 characters in length. And the characters ~ ! @ # $ % ^ & * ( ) < > + . ? are illegal.


For example, rulename_test.

Description

Description of the rule, less than 1024 characters in length.

Network Element Type

Type of the network element


For example, CLASSIC_CUSTOM3.

Network Element/Network Element Group

NE or NE Group that needs to deploy the Loose Error Handle rule.


For example, NE_2.

Inbound Triggers

List of service JDV triggers


For example, CreateCustom3@http://schemas.ericsson.com/ma/CA/Custom3/ .

Outbound Triggers

List of resource JDV triggers.


For example, CreateCustom3_RESOURCE@http://schemas.ericsson.com/ma/CA/Custom3/,

Error codes

The Looseable Error Code which can be ignored by NE or NE Group.


For example, 1001 - External Errors.

17.2   Adding a Rule

To add a rule, follow these steps:

  1. Click Add Rule.
  2. In General, specify the Name, Description rule, Network Element Type, and Network Element/Network Element Group of the rule according to Table 30.

    Click Next or JDV Information.

  3. In JDV Information, choose Pre-defined Rules or Advance Rule.
    • Pre-defined Rules- select a rule from the pre-defined rule list.
    • Advanced Rule- specify Inbound Triggers, Outbound Triggers, Error codes of the rule according to Table 30 .

    Click Next or Summary.

  4. In Summary, Click Finish to add this rule to system.

17.3   Removing rules

To Remove one or more rules, follow these steps:

  1. In front page, check the check box on the left of the rule to be deleted.
  2. Click Delete.

or

  1. In Rule Detail page of the rule to be deleted, click Delete.

17.4   Editing a Rule

To edit a rule, follow these steps:

  1. In Rule Detail, click Edit to edit this rule.
  2. Click Apply.

17.5   Duplicating a Rule

To duplicate a rule, follow these steps:

  1. In Rule Detail, click Duplicate to duplicate an existing rule.
  2. Click Apply.

18   Appendix A - Standard Product Activation Logic

Table 31 shows all the standard product activation logic components that are available in Dynamic Activation.

Table 31    Standard Product Activation Logics

JDV-AAA-Monolithic-Provisioning

JDV-AAA-Provisioning

JDV-AF-Monolithic-Resource-Provisioning

JDV-AF-Monolithic-Service-Provisioning

JDV-AIR-Monolithic-Resource-Provisioning

JDV-AIR-Monolithic-Service-Provisioning

JDV-AUC-Massive-Provisioning

JDV-AUC-Subscriber-Provisioning

JDV-BCE-Resource-Provisioning

JDV-BCE-Service-Provisioning

JDV-CA-Provisioning

JDV-CG-AUC-CAI-Provisioning

JDV-CG-AUC-Provisioning

JDV-CG-HLR-CAI-Provisioning

JDV-CG-HLR-Provisioning

JDV-CG-MNP-CAI-Provisioning

JDV-CG-MNP-Provisioning

JDV-CSAPC-Monolithic-Resource-Provisioning

JDV-CUDB-IMSI-Changeover-Provisioning

JDV-CUDB-SUBDEL-Provisioning

JDV-CUDB-Subscriber-Provisioning

JDV-DAE-Provisioning

JDV-EIR-Provisioning

JDV-ENUM-Layered-Resource-Provisioning

JDV-ENUM-Monolithic-Resource-Provisioning

JDV-ENUM-Service-Provisioning

JDV-ESIM-SV-Provisioning

JDV-FNR-Monolithic-Subscriber-Provisioning

JDV-HLR-Massive-Provisioning

JDV-HLR-Profile-Provisioning

JDV-HLR-Service-Associated-Data-Provisioning

JDV-HLR-Monolithic-Subscriber-Provisioning

JDV-HSS-AVG-Provisioning

JDV-HSS-EPS-Massive-Provisioning

JDV-HSS-EPS-Provisioning

JDV-HSS-IMS-Provisioning

JDV-HSS-Monolithic-Provisioning

JDV-ILF-Resource-Provisioning

JDV-ILF-Service-Provisioning

JDV-M2M-Provisioning

JDV-M2M-Service-Profile-Provisioning

JDV-MML-Converter

JDV-MNP-Provisioning

JDV-MTAS-Resource-Provisioning

JDV-MTAS-Service-Provisioning

JDV-PGM-Document-Resource-Provisioning

JDV-PGM-Document-Service-Provisioning

JDV-PGM-User-Resource-Provisioning

JDV-PGM-User-Service-Provisioning

JDV-EMA-Scheduled-Procedures

JDV-SAPC-Layered-Resource-Provisioning

JDV-SAPC-Monolithic-Resource-Provisioning

JDV-SAPC-Service-Provisioning

JDV-VoWifi-SV-Provisioning


Reference List

Ericsson Documents
[1] Library Overview, 18/1553-CSH 109 628 Uen
[2] Configuration Manual for Resource Activation, 2/1543-CSH 109 628 Uen
[3] Customer Adaptation Development Guide for Resource Activation, 5/1553-CSH 109 628 Uen
[4] Function Specification Resource Activation, 3/155 17-CSH 109 628 Uen
[5] System Administrators Guide for Native Deployment, 1/1543-CSH 109 628 Uen
[6] System Administrators Guide for Virtual and Cloud Deployment, 3/1543-CSH 109 628 Uen
[7] MTAS Provisioning over CAI3G, 30/155 19-CSH 109 628 Uen
[8] User Guide for Designer Studio, 10/1553-CSH 109 628 Uen
[9] Function Specification Dynamic Activation Execution Environment, 3/155 17-CSH 109 628 Uen
[10] User Guide for Batch Handler, 12/1553-CSH 109 628 Uen
[11] Northbound Interface Adapter Customization Development Guide for CLI-Based Protocol, 26/1553-CSH 109 628 Uen
Online References
[12] XML Path Language (XPath) 3.0 https://www.w3.org/TR/xpath-30/.


Copyright

© Ericsson AB 2017. All rights reserved. No part of this document may be reproduced in any form without the written permission of the copyright owner.

Disclaimer

The contents of this document are subject to revision without notice due to continued progress in methodology, design and manufacturing. Ericsson shall have no liability for any error or damage of any kind resulting from the use of this document.

Trademark List
All trademarks mentioned herein are the property of their respective owners. These are shown in the document Trademark Information.

    User Guide for Resource Activation         Ericsson Dynamic Activation 1