5529 APC Release 9.3.10 Installation and Customization Guide PDF

Download as pdf or txt
Download as pdf or txt
You are on page 1of 92

INSTALLATION AND CUSTOMIZATION GUIDE

Alcatel-Lucent 5529
ACCESS PROVISIONING CENTER | RELEASE 9.3.10
INSTALLATION AND CUSTOMIZATION GUIDE

3JL-02001-CAAA-RJ ZZA Edition 01

Alcatel-Lucent Proprietary
This document contains proprietary information of Alcatel-Lucent and is not to be disclosed
or used except in accordance with applicable agreements.
Copyright 2014 © Alcatel-Lucent. All rights reserved.
Alcatel-Lucent assumes no responsibility for the accuracy of the information presented, which is
subject to change without notice.
Alcatel, Lucent, Alcatel-Lucent and the Alcatel-Lucent logo are trademarks of Alcatel-Lucent. All
other trademarks are the property of their respective owners.

Copyright 2014 Alcatel-Lucent.


All rights reserved.

Disclaimers

Alcatel-Lucent products are intended for commercial uses. Without the appropriate network design
engineering, they must not be sold, licensed or otherwise distributed for use in any hazardous
environments requiring fail-safe performance, such as in the operation of nuclear facilities, aircraft
navigation or communication systems, air traffic control, direct life-support machines, or weapons
systems, in which the failure of products could lead directly to death, personal injury, or severe physical
or environmental damage. The customer hereby agrees that the use, sale, license or other distribution
of the products for any such application without the prior written consent of Alcatel-Lucent, shall be at
the customer's sole risk. The customer hereby agrees to defend and hold Alcatel-Lucent harmless from
any claims for loss, cost, damage, expense or liability that may arise out of or in connection with the
use, sale, license or other distribution of the products in such applications.
This document may contain information regarding the use and installation of non-Alcatel-Lucent
products. Please note that this information is provided as a courtesy to assist you. While Alcatel-Lucent
tries to ensure that this information accurately reflects information provided by the supplier, please refer
to the materials provided with any non-Alcatel-Lucent product and contact the supplier for
confirmation. Alcatel-Lucent assumes no responsibility or liability for incorrect or incomplete
information provided about non-Alcatel-Lucent products.
However, this does not constitute a representation or warranty. The warranties provided for
Alcatel-Lucent products, if any, are set forth in contractual documentation entered into by
Alcatel-Lucent and its customers.
This document was originally written in English. If there is any conflict or inconsistency between the
English version and any other version of a document, the English version shall prevail.

When printed by Alcatel-Lucent, this document is printed on recycled paper.


Preface

The 5529 Access Provisioning Center Installation and Customization Guide


describes how to:
• install and uninstall the 5529 APC software in single-server and cluster
deployment models
• install and uninstall the NE support plug-ins
• install and uninstall the SPFE
• install and uninstall the SPFE support plug-ins
• back up and restore the database
• migrate the 5529 APC, including migrate NEs from 5523 AWS to 5520 AMS
while the 5529 APC is online or offline
• translate the 5529 APC GUI

Audience
This document is intended for planners, administrators, operators, and maintenance
personnel that install, upgrade, or maintain the 5529 APC. The users must be familiar
with general telecommunications principles, and the structure and architecture of the
5529 APC and 5520 AMS.

Related documentation
Table 1 lists other related documentation sources that you may need to reference.

Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10 June 2014 iii
3JL-02001-CAAA-RJZZA Edition 01
Installation and Customization Guide
Preface

Table 1 Related documentation

Customer documentation Description

5529 Access Provisioning Center

5529 Access Provisioning Center Release Notice Provides an overview of the contents of the
5529 APC software load, including known
restrictions

5529 Access Provisioning Center User Guide Provides information about how to navigate and
use the 5529 APC GUI

5529 Access Provisioning Center Service Provides information about how to navigate and
Provisioning Front End Guide use the 5529 APC SPFE GUI, which can be
installed with the 5520 AMS client when the
5529 APC is integrated with the 5520 AMS

5520 Access Management System

5520 AMS Solution Planning Guide Provides information about the system
requirements for the installation of the
5520 AMS server and client
5520 AMS Installation and Migration Guide Provides information about how to install the
5520 AMS server and client, and use the feature
updates function for the client. Also describes
how to migrate from the 5523 AWS to the
5520 AMS.
5520 AMS Administrator Guide Provides information about administrative
functions, including management of
server-client communication, users, NE
communication, and schedules

5520 AMS Solution Glossary Provides descriptions of terms and acronyms


related to the 5520 AMS and 5529 Enhanced
Applications

5523 ADSL WorkStation


5523 AWS ANEL User Guide Provides information about the 5523 AWS
Network Element List

5523 AWS Operator Guide Provides information about the 5523 AWS EML
subsystem

Conventions used in this guide


Table 2 lists the conventions that are used in this guide.

Table 2 Documentation conventions

Convention Description Example

Key name Press a keyboard key. Delete

Italics Identifies a variable hostname

Key+Key Type the appropriate consecutive keystroke sequence. CTRL+G

Key-Key Type the appropriate simultaneous keystroke CTRL-G


sequence.

(1 of 2)

iv June 2014 Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10


Edition 01 3JL-02001-CAAA-RJZZA
Installation and Customization Guide
Preface

Convention Description Example

↵ Press the Return or Enter key. ↵

— An em dash in a table cell indicates that there is no —


information or that the category is not applicable.

* An asterisk is a wildcard character that means “any *


character” in a search argument.
Indicates a value must be entered for the parameter Name *

→ Indicates that a cascading submenu results from Administration→System


selecting a menu item settings

(2 of 2)

Important information
The following are examples of how important information is presented in this
document:
Warning — Warning indicates that the described activity or situation
may, or will, cause equipment damage or serious performance
problems.

Caution — Caution indicates that the described activity or situation


may, or will, cause service interruption.

Note — Note provides information that is, or may be, of special


interest.

Procedures with options or substeps


When there are options in a procedure, they are identified by letters. When there are
substeps in a procedure, they are identified by roman numerals.

Procedure 1 Example of options in a procedure

At step 1, you can choose option a or b. At step 2, you must do what the step indicates.

1 This step offers two options. You must choose one of the following:

a This is one option.

b This is another option.

2 You must perform this step.

Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10 June 2014 v


3JL-02001-CAAA-RJZZA Edition 01
Installation and Customization Guide
Preface

Procedure 2 Example of substeps in a procedure

At step 1, you must perform a series of substeps within a step. At step 2, you must do
what the step indicates.

1 This step has a series of substeps that you must perform to complete the step. You
must perform the following substeps:

i This is the first substep.

ii This is the second substep.

iii This is the third substep.

2 You must perform this step.

Multiple PDF file search


You can use Adobe Reader, Release 6.0 or later, to search multiple PDF files for a
term. Adobe Reader displays the results in a display panel. The results are grouped
by PDF file. You can expand the entry for each file.
Note — The PDF files in which you search must be in the same
folder.

Procedure 3 To search multiple PDF files for a term


1 Open the Adobe Reader.

2 Choose Edit→Search from the Adobe Reader main menu. The Search panel opens.

3 Enter the term to search for.

4 Select the All PDF Documents in radio button.

5 Choose the folder in which to search using the drop-down menu.

6 Select the following search criteria, if required:

• Whole words only


• Case-Sensitive
• Include Bookmarks
• Include Comments

7 Click on the Search button.

vi June 2014 Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10


Edition 01 3JL-02001-CAAA-RJZZA
Installation and Customization Guide
Preface

Adobe Reader displays the search results. You can expand the entries for each file
by clicking on the + symbol.

Note — After you click on a hyperlink, you can right-click and choose
Previous View from the contextual menu to return to the location of the
hyperlink that you clicked on.

Contact information
If you have questions or comments about this documentation, click on the following
link:
[email protected]

Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10 June 2014 vii
3JL-02001-CAAA-RJZZA Edition 01
Installation and Customization Guide
Preface

viii June 2014 Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10
Edition 01 3JL-02001-CAAA-RJZZA
Installation and Customization Guide
Contents

Preface iii
Audience ............................................................................................... iii
Related documentation ............................................................................... iii
Conventions used in this guide....................................................................... iv
Important information.................................................................. v
Procedures with options or substeps ................................................. v
Procedure 1 Example of options in a procedure................................... v
Procedure 2 Example of substeps in a procedure ................................ vi
Multiple PDF file search............................................................................... vi
Procedure 3 To search multiple PDF files for a term ............................ vi
Contact information .................................................................................. vii

Getting started

1— What’s new 1-1


1.1 What’s new in Release 9.3.10......................................................... 1-2
1.2 What’s new in Release 9.3.0 .......................................................... 1-2
1.3 What’s new in Release 9.2.30......................................................... 1-2

2— About the 5529 APC 2-1


2.1 5529 APC overview...................................................................... 2-2
2.2 Deployment models..................................................................... 2-2
Protocols, ports, and firewalls ..................................................... 2-5
Consolidation ......................................................................... 2-6
2.3 Platform and system requirements................................................... 2-6

Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10 June 2014 ix


3JL-02001-CAAA-RJZZA Edition 01
Installation and Customization Guide
Contents

2.4 Technical support ....................................................................... 2-6


Procedure 2-1 To find contact information for technical assistance........ 2-6

Installing the 5529 APC and SPFE

3— Install the 5529 APC and SPFE 3-1


3.1 Installation overview ................................................................... 3-2
Directories............................................................................. 3-2
Environment variables............................................................... 3-3
Licenses................................................................................ 3-3
Users ................................................................................... 3-4
System components.................................................................. 3-4
3.2 Installing a single-server 5529 APC .................................................. 3-5
Software plug-in installation tasks ................................................ 3-5
Procedure 3-1 High-level procedure for single-server installation
of the 5529 APC ................................................................ 3-6
3.3 Installing a cluster 5529 APC .......................................................... 3-7
HTTPS client connection to the cluster........................................... 3-7
Software plug-in installation tasks ................................................ 3-8
Procedure 3-2 High-level procedure for cluster installation of the
5529 APC......................................................................... 3-8
3.4 Starting the 5529 APC GUI for the first time as the system
administrator .................................................................... 3-10
Procedure 3-3 To start the 5529 APC GUI for the first time as the
system administrator ......................................................... 3-10
3.5 Logging out of the 5529 APC GUI .................................................... 3-14
Procedure 3-4 To log out of the 5529 APC GUI ................................ 3-14
3.6 Installing the SPFE ..................................................................... 3-15
Procedure 3-5 To install the SPFE ............................................... 3-15
3.7 Logging in to the 5529 APC as an amssys user ..................................... 3-16
Procedure 3-6 To log in to the 5529 APC server as an amssys user......... 3-17

Managing plug-ins

4— Manage NE support plug-ins 4-1


4.1 NE support plug-in management overview .......................................... 4-2
SPFE NE support plug-ins............................................................ 4-3
4.2 NE support plug-in management tasks............................................... 4-3

5— Manage AVG plug-ins 5-1


5.1 AVG plug-in management overview .................................................. 5-2
AVG plug-in management window ................................................. 5-2
AVG plug-in management tasks .................................................... 5-2

x June 2014 Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10


Edition 01 3JL-02001-CAAA-RJZZA
Installation and Customization Guide
Contents

5.2 Installing the AVG plug-in container ................................................. 5-3


Procedure 5-1 To install an AVG plug-in container ............................ 5-3
5.3 Installing, activating, and upgrading AVG plug-ins ................................ 5-4
Procedure 5-2 To install and activate AVG plug-ins ........................... 5-5
Procedure 5-3 To upgrade AVG plug-ins ......................................... 5-6
5.4 Uninstalling an AVG plug-in............................................................ 5-6

Migrating

6— Migrate the 5529 APC 6-1


6.1 5529 APC migration overview ......................................................... 6-2
Data migration........................................................................ 6-2
6.2 5529 APC and 5520 AMS migration from Release 9.3.0, 9.2.30, and
9.2.10 .............................................................................. 6-3
Required resources and applications for 5529 APC migration................. 6-3
Preparing to migrate the 5529 APC................................................ 6-4
Migrating the 5529 APC.............................................................. 6-4

7— Migrate NEs from 5523 AWS to 5520 AMS 7-1


7.1 Overview of NE migration from 5523 AWS to 5520 AMS ........................... 7-2
7.2 Adding an EML provider ................................................................ 7-2
Procedure 7-1 To add an EML provider .......................................... 7-2
7.3 Migrating NEs from 5523 AWS to 5520 AMS offline from 5529 APC .............. 7-3
Procedure 7-2 To migrate NEs from 5523 AWS to 5520 AMS offline
from 5529 APC .................................................................. 7-4
7.4 Migrating NEs from 5523 AWS to 5520 AMS online with 5529 APC ............... 7-4
Procedure 7-3 To migrate NEs from 5523 AWS to 5520 AMS online
with 5529 APC .................................................................. 7-4
7.5 Migrating NEs from 5520 AMS to 5523 AWS online with 5529 APC ............... 7-5
Procedure 7-4 To migrate NEs from 5520 AMS to 5523 AWS online
with 5529 APC .................................................................. 7-5

Uninstalling the 5529 APC and SPFE

8— Uninstall the 5529 APC and SPFE 8-1


8.1 Uninstallation overview ................................................................ 8-2
Before you proceed .................................................................. 8-2
8.2 Uninstalling a 5529 APC NE support plug-in or SPFE NE support plug-in........ 8-2
8.3 Uninstalling an AVG plug-in............................................................ 8-3
Procedure 8-1 To uninstall AVG plug-ins......................................... 8-3
8.4 Uninstalling the 5529 APC server ..................................................... 8-4
8.5 Uninstalling the SPFE ................................................................... 8-4

Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10 June 2014 xi


3JL-02001-CAAA-RJZZA Edition 01
Installation and Customization Guide
Contents

Customizing the 5529 APC

9— Translate the 5529 APC GUI 9-1


9.1 GUI translation overview............................................................... 9-2
9.2 Translating the GUI ..................................................................... 9-3
Prerequisites .......................................................................... 9-3
Procedure 9-1 To translate the 5529 APC GUI menus and windows ......... 9-3
Procedure 9-2 To translate the html.properties file........................... 9-5
Procedure 9-3 To translate the NE support plug-in templates ............... 9-6

xii June 2014 Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10
Edition 01 3JL-02001-CAAA-RJZZA
Installation and Customization Guide
Contents

List of figures
Figure 2-1 5529 APC single-server deployment model ........................................ 2-4
Figure 2-2 5529 APC cluster deployment model................................................ 2-5
Figure 3-1 Components of a single-server 5529 APC deployment ........................... 3-4
Figure 3-2 Components of a cluster 5529 APC deployment................................... 3-5
Figure 3-3 Cluster 5529 APC deployment—JMS client connection to the cluster.......... 3-8
Figure 3-4 Access Provisioning Center login window ......................................... 3-11
Figure 3-5 User management window .......................................................... 3-12
Figure 3-6 System settings window.............................................................. 3-13
Figure 5-1 AVG Plugin management window.................................................... 5-2

List of tables
Table 1 Related documentation .................................................................... iv
Table 2 Documentation conventions ............................................................... iv
Table 1-1 What’s new in Release 9.3.10 ......................................................... 1-2
Table 1-2 What’s new in Release 9.3.0........................................................... 1-2
Table 1-3 What’s new in Release 9.2.30 ......................................................... 1-3
Table 2-1 5529 APC deployment models ......................................................... 2-2
Table 3-1 Directories on the 5529 APC server ................................................... 3-3
Table 3-2 URL NE provider parameters.......................................................... 3-14
Table 4-1 NE support plug-in binary installation files.......................................... 4-2
Table 4-2 SPFE NE support plug-in binary installation files ................................... 4-3
Table 4-3 NE support plug-in management tasks ............................................... 4-3
Table 5-1 AVG plug-in management tasks ....................................................... 5-3
Table 6-1 5529 APC upgrade support between operating systems and
architectures...................................................................... 6-2
Table 7-1 EML provider parameters............................................................... 7-3
Table 9-1 Property files............................................................................. 9-2
Table 9-2 NE support plug-in template .sar filename and directory variables ............. 9-7
Table 9-3 NE support plug-in template .properties filename variables ..................... 9-8

List of procedures
Procedure 1 Example of options in a procedure .................................................. v
Procedure 2 Example of substeps in a procedure ................................................ vi
Procedure 3 To search multiple PDF files for a term............................................ vi
Procedure 2-1 To find contact information for technical assistance ....................... 2-6
Procedure 3-1 High-level procedure for single-server installation of the
5529 APC........................................................................... 3-6
Procedure 3-2 High-level procedure for cluster installation of the 5529 APC ............. 3-8
Procedure 3-3 To start the 5529 APC GUI for the first time as the system
administrator .................................................................... 3-10
Procedure 3-4 To log out of the 5529 APC GUI ................................................ 3-14

Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10 June 2014 xiii
3JL-02001-CAAA-RJZZA Edition 01
Installation and Customization Guide
Contents

Procedure 3-5 To install the SPFE ............................................................... 3-15


Procedure 3-6 To log in to the 5529 APC server as an amssys user ........................ 3-17
Procedure 5-1 To install an AVG plug-in container ............................................ 5-3
Procedure 5-2 To install and activate AVG plug-ins ........................................... 5-5
Procedure 5-3 To upgrade AVG plug-ins ......................................................... 5-6
Procedure 7-1 To add an EML provider .......................................................... 7-2
Procedure 7-2 To migrate NEs from 5523 AWS to 5520 AMS offline from 5529 APC ...... 7-4
Procedure 7-3 To migrate NEs from 5523 AWS to 5520 AMS online with 5529 APC ....... 7-4
Procedure 7-4 To migrate NEs from 5520 AMS to 5523 AWS online with 5529 APC ....... 7-5
Procedure 8-1 To uninstall AVG plug-ins ........................................................ 8-3
Procedure 9-1 To translate the 5529 APC GUI menus and windows......................... 9-3
Procedure 9-2 To translate the html.properties file .......................................... 9-5
Procedure 9-3 To translate the NE support plug-in templates............................... 9-6

xiv June 2014 Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10
Edition 01 3JL-02001-CAAA-RJZZA
Installation and Customization Guide
Getting started

1 — What’s new

2 — About the 5529 APC

Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10 June 2014


3JL-02001-CAAA-RJZZA Edition 01
Installation and Customization Guide
June 2014 Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10
Edition 01 3JL-02001-CAAA-RJZZA
Installation and Customization Guide
1— What’s new

1.1 What’s new in Release 9.3.10 1-2

1.2 What’s new in Release 9.3.0 1-2

1.3 What’s new in Release 9.2.30 1-2

Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10 June 2014 1-1
3JL-02001-CAAA-RJZZA Edition 01
Installation and Customization Guide
1 — What’s new

1.1 What’s new in Release 9.3.10

Table 1-1 describes the 5529 APC features and enhancements that were added to the
5529 Access Provisioning Center Installation and Customization Guide for
Release 9.3.10.

Table 1-1 What’s new in Release 9.3.10

Feature/enhancement Description See

Migration paths to Migration from 5529 APC R9.3.0, R9.2.30, and Chapter 6
Release 9.3.10 R9.2.10 is supported, including between SPARC and
x86 architectures.

1.2 What’s new in Release 9.3.0

Table 1-2 describes the 5529 APC features and enhancements that were added to the
5529 Access Provisioning Center Installation and Customization Guide for
Release 9.3.0.

Table 1-2 What’s new in Release 9.3.0

Feature/enhancement Description See

Features

Migration paths to Migration from the 5529 APC R9.2.30 is supported, Chapter 6
Release 9.3.0 including between SPARC and x86 architectures.

Migrating a cluster When you migrate a cluster installation from


installation to the Red 5529 APC R9.2.30 to R9.3.0, you can migrate to the
Hat Enterprise Linux Red Hat Enterprise Linux architecture.
architecture

Documentation changes

5529 Access Provisioning The 5529 Access Provisioning Center Glossary is 5520 AMS
Center Glossary removed as of Release 9.3.0. The 5529 APC-related Solution
terms are now listed in the 5520 AMS Solution Glossary
Glossary.

1.3 What’s new in Release 9.2.30

Table 1-3 describes the 5529 APC features and enhancements that were added to the
5529 Access Provisioning Center Installation and Customization Guide for
Release 9.2.30.

1-2 June 2014 Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10
Edition 01 3JL-02001-CAAA-RJZZA
Installation and Customization Guide
1 — What’s new

Table 1-3 What’s new in Release 9.2.30

Feature/enhancement Description See

Features

Installer script modes The installer script can be run in one of two modes: Section 3.1
interactive and non-interactive.

7324 RU support The 7324 RU NE is not supported by 5529 APC as of Table 4-1
Release 9.2.30.

Migration paths to Migration from the 5529 APC R9.1.0, R9.1.10, Table 6-1
Release 9.2.30 R9.2.10, and R9.2.20 is supported, including
between Solaris SPARC and Solaris x86
architectures.

New migration The procedure to upgrade from 5529 APC R9.1.0 Chapter 6
procedures for R9.2.10 and R9.1.10 to R9.2.30 remains the same as the
and R9.2.20 previous 5529 APC release and uses the
export/import mechanism.

New procedures to upgrade from R9.2.10 and Chapter 6


R9.2.20 to R9.2.30 are provided. Data files for the
5520 AMS, 5529 Enhanced Applications, and NE
support plug-ins are copied by running the
ams_copy_datafiles script on the data server.
The script can be run in one of two modes:
interactive and non-interactive.
Two new migration strategies are also supported:
in-place migration and out-of-place migration.

Documentation changes
Data server terminology Replaced the term slave data server with standby Chapter 6
change data server in the document.

Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10 June 2014 1-3
3JL-02001-CAAA-RJZZA Edition 01
Installation and Customization Guide
1 — What’s new

1-4 June 2014 Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10
Edition 01 3JL-02001-CAAA-RJZZA
Installation and Customization Guide
2— About the 5529 APC

2.1 5529 APC overview 2-2

2.2 Deployment models 2-2

2.3 Platform and system requirements 2-6

2.4 Technical support 2-6

Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10 June 2014 2-1
3JL-02001-CAAA-RJZZA Edition 01
Installation and Customization Guide
2 — About the 5529 APC

2.1 5529 APC overview

The 5529 APC is a web-based software application that helps you automate the
following daily operations for the service provisioning of access NEs:
• user port configuration, which is used to configure ports that are in a
ready-to-offer-services state
• service activation, which is used to activate services for a configured port
• audit functions to synchronize the OSS client and the network with respect to
service configurations
• notification of service configuration changes among OSSs that collaborate in
service provisioning

The 5529 APC provides two modules to support daily service provisioning
operations:
• Multi-Service Activation Interface (MSAI)—Web services for service
provisioning automation with OSS. The northbound interface uses templates for
user port configuration and service management.
• Service Provisioning Front End (SPFE)—GUI for service provisioning and
activation from within the 5520 AMS.

Service provisioning tasks that are performed less frequently are also supported:
• design and life cycle management of service templates in preparation for service
roll-out. You can configure the templates using the 5529 APC GUI, as described
in the 5529 Access Provisioning Center User Guide.
• mass line modifications
• bulk requests
• administration of notification groups to enable collaborative service provisioning
among OSSs
• system administrator tasks such as applying the appropriate security measures,
configuring system-wide settings, creating account profiles and accounts, and
adding and synchronizing providers with the 5529 APC

2.2 Deployment models

Table 2-1 describes the deployment models for the 5529 APC.

Table 2-1 5529 APC deployment models

Deployment Server details EMS Supported options


model
SPFE Configuration 5520 AMS 5529 APC
change notifications geo-redundancy
notifications

Single-server One server (5529 APC 5520 AMS ✓ ✓ ✓ ✓ (1)


and 5520 AMS share
the same JBoss)

(1 of 2)

2-2 June 2014 Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10
Edition 01 3JL-02001-CAAA-RJZZA
Installation and Customization Guide
2 — About the 5529 APC

Deployment Server details EMS Supported options


model
SPFE Configuration 5520 AMS 5529 APC
change notifications geo-redundancy
notifications

Cluster Multiple servers 5520 AMS ✓ ✓ ✓ ✓ (1)


(5529 APC is in each
5520 AMS server
workstation in a
5520 AMS cluster) (2)

(2 of 2)

Notes
(1) Geo-redundancy of the 5529 APC is provided by the 5520 AMS when the 5520 AMS is configured in a geographically
redundant deployment.
(2) A load balancer is optional but recommended in a 5529 APC cluster deployment.

Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10 June 2014 2-3
3JL-02001-CAAA-RJZZA Edition 01
Installation and Customization Guide
2 — About the 5529 APC

Figure 2-1 shows the 5529 APC in a single-server deployment in the network. The
5529 APC and 5520 AMS are in the same server. The 5529 APC shares the JBoss
application server with the 5520 AMS.

Figure 2-1 5529 APC single-server deployment model

Service provisioning
operations

OSS application

MSAI (XML/SOAP)
(optional)
5520 AMS SPFE operator Service template
operators (optional) designer

5520 AMS 5529 APC


application

JBoss 5520 AMS


server Database
Database server Single-server 5529 APC
deployment with 5520 AMS

SNMP/
TFTP

Router

CPE

NE
Management
PVC

19777

2-4 June 2014 Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10
Edition 01 3JL-02001-CAAA-RJZZA
Installation and Customization Guide
2 — About the 5529 APC

Figure 2-2 shows the 5529 APC in a cluster deployment in the network in which the
5529 APC is installed on all of the servers in a 5520 AMS cluster.

Figure 2-2 5529 APC cluster deployment model

Service provisioning
operations

OSS application

MSAI (XML/SOAP)
(optional)
5520 AMS SPFE operator Service template
operators (optional) designer

Load
balancer
(optional)

5520 AMS 5520 AMS 5520 AMS


server 1 and server 2 and server 3 and
5529 APC 5529 APC 5529 APC
primary EMS optional secondary
EMS

SNMP/
TFTP

Router

CPE

NE
Management
PVC

20485

Protocols, ports, and firewalls


See the 5520 AMS Solution Planning Guide for information about port
communications.

Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10 June 2014 2-5
3JL-02001-CAAA-RJZZA Edition 01
Installation and Customization Guide
2 — About the 5529 APC

Consolidation
If a service provider needs to combine two 5529 APC systems into a 5529 APC,
some preconditions must be satisfied to enable a feasible and sensible consolidation:
• different NEs are not addressed by an identical NE name in both originating
5529 APC systems
• templates from both systems are either disjunct (represent different services), or
the templates in both systems are identical (represent identical services)
• user management is assumed to be identical in both systems
• both systems are at the same 5529 APC version
• consolidation of remote usage statistics is not intended
• system parameters need to be consolidated

2.3 Platform and system requirements

For information about hardware and software requirements see the 5520 AMS
Solution Planning Guide.
For information on how to prepare hardware for installation of the 5520 AMS and
5529 APC, including information about installing the server, setting up a cluster, and
configuring a network, see the 5520 AMS Server Configuration Technical
Guidelines.

2.4 Technical support

Procedure 2-1 provides the steps to find the contact information for technical
assistance for a country.

Procedure 2-1 To find contact information for technical assistance


1 Go to http://support.alcatel-lucent.com.

2 Log in to the Alcatel-Lucent Customer and Business Partner Portals with the
username and password for your OLCS account. A customized Customer Center
page opens.

3 Under Product Technical Support, select a country. The Alcatel-Lucent Support


Contact Numbers window opens and displays the phone and e-mail contact
information for technical assistance for the selected country.

2-6 June 2014 Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10
Edition 01 3JL-02001-CAAA-RJZZA
Installation and Customization Guide
Installing the 5529 APC and SPFE

3 — Install the 5529 APC and SPFE

Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10 June 2014


3JL-02001-CAAA-RJZZA Edition 01
Installation and Customization Guide
June 2014 Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10
Edition 01 3JL-02001-CAAA-RJZZA
Installation and Customization Guide
3— Install the 5529 APC and SPFE

3.1 Installation overview 3-2

3.2 Installing a single-server 5529 APC 3-5

3.3 Installing a cluster 5529 APC 3-7

3.4 Starting the 5529 APC GUI for the first time as the system
administrator 3-10

3.5 Logging out of the 5529 APC GUI 3-14

3.6 Installing the SPFE 3-15

3.7 Logging in to the 5529 APC as an amssys user 3-16

Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10 June 2014 3-1
3JL-02001-CAAA-RJZZA Edition 01
Installation and Customization Guide
3 — Install the 5529 APC and SPFE

3.1 Installation overview

This chapter describes the installation procedures for the single-server and cluster
deployment models of the 5529 APC. If you are migrating from a previous release
of the 5529 APC, see chapter 6.
Procedures include pre-installation, installation, and post-installation tasks, both
mandatory and optional. Verify that all mandatory procedures have been performed.
Table 2-1 describes the deployment models.

Note — Alcatel-Lucent recommends that you review section 2.3


before you install the 5529 APC.

Installing the 5529 APC puts the software files in the correct location ready for use.
However, until you activate a server, the server is in a passive, standby mode.
Activating the software ensures that the plug-in installation environment is ready and
that it is safe to start the server.
The installer script can be run in one of two modes:
• interactive
• non-interactive
The interactive mode requires you to interact with the script and respond to a series
of command line prompts as the script is running. The non-interactive mode allows
you to provide a set of command line parameters up front when you run the script
and not have to interact with the script while it is running. The parameters provide
the same data that you would provide at the prompts in the interactive mode. See the
5520 AMS Installation and Migration Guide for more information.
Starting the server starts the 5529 APC processes.

Directories
Different components of the 5529 APC are installed in different directories on the
server; you are prompted for these locations during installation. This includes
separate locations for:
• 5529 APC server software
• MySQL database
• local data storage
• shared data storage

Choose and configure these locations before starting the installation.


Table 3-1 describes the top directories that are installed on the 5529 APC server.

3-2 June 2014 Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10
Edition 01 3JL-02001-CAAA-RJZZA
Installation and Customization Guide
3 — Install the 5529 APC and SPFE

Table 3-1 Directories on the 5529 APC server

Directory Description

$AMS_LOCAL_DATA_DIR/ams/local/repository/plug-in_name (1) Software and NE support plug-in


directory

$AMSSFTPDB_USER_HOME_DIR User home directory

$AMS_SOFTWARE_HOME Software directory

$AMS_LOCALDATA_HOME Local data directory

$AMS_SHAREDDATA_HOME Shared data directory

$AMS_DATABASE_DIR/ams/database/release (2) Database directory

Notes
(1) plug-in_name is the name of a 5529 APC server plug-in or NE support plug-in; for example,
app-apc-9.3.10.0_9.3.10-999000-solaris-sparc.bin,
app-apc-9.3.10.0_9.3.10-999000-solaris-x86.bin,
app-apc-9.3.10.0_9.3.10-999000-184628-redhat-x86_64.bin, or
plugin-apc-isam-4.3-1.0_9.3.10_9.3.10-999000.bin
(2) release is the release of the 5529 APC software or 5520 AMS software; for example, ams-9.3.10.0

Environment variables
The 5520 AMS defines environment variables for directories on the servers. These
variables can be used by the amssys user. The 5520 AMS Installation and Migration
Guide describes environment variables used in the procedures found in this guide.

Licenses
Your license from Alcatel-Lucent includes a 5529 APC license key, in the form of a
long string of alphanumeric characters. The license key encodes the set of features
you have licensed, the period of the license, and for some objects the quantity to
which your license entitles you.
Enter the 5529 APC license key on the 5520 AMS license page, just as you did the
5520 AMS license. Project-specific licenses can be entered at the same time on the
license page. For information about installing a license in the 5520 AMS, see the
5520 AMS Installation and Migration Guide.
The 5520 AMS raises an alarm when a license is close to its expiry date. Licenses
are checked at startup and each day at midnight. A minor alarm is raised when a
license is 60 days from expiring, a major alarm is raised when a license is 30 days
from expiring, and a critical alarm is raised when a license is 7 days or less from
expiring.
For more information on licenses, see the 5520 AMS Administrator Guide.

Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10 June 2014 3-3
3JL-02001-CAAA-RJZZA Edition 01
Installation and Customization Guide
3 — Install the 5529 APC and SPFE

Users
When you install the 5529 APC, the following UNIX user accounts are created on
the server:
• amssys—account used to start the server. The default password for the amssys
user account is amssys; you are prompted to change the password when the
installation is complete.
• amsftp—account used by the system for FTP operations. The default password
for the amsftp user account is amsftp. You can change the password for amsftp.
See the 5520 AMS Administrator Guide and the 5520 AMS Installation and
Migration Guide for more information.
• amssftp—account used by the system for SFTP operations. The default password
for the amssftp user account is amssftp. You can change the password for
amssftp. See the 5520 AMS Administrator Guide and the 5520 AMS Installation
and Migration Guide for more information.

The root account can perform any action.

Note — Alcatel-Lucent recommends that you change the default


passwords after you install the 5529 APC, and keep the password
safe.

System components
Figure 3-1 shows the components of a single-server 5529 APC deployment.

Figure 3-1 Components of a single-server 5529 APC deployment

Single-server 5529 APC deployment

5529 APC NE SPFE NE NE support plug-ins for other


support plug-ins support plug-ins 5529 Enhanced Applications

Other 5529
5529 APC SPFE Enhanced Applications

5520 AMS

JBoss application server

5520 AMS MySQL database

MySQL database server

Operating system

22478

Figure 3-2 shows the components of a cluster 5529 APC deployment.

3-4 June 2014 Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10
Edition 01 3JL-02001-CAAA-RJZZA
Installation and Customization Guide
3 — Install the 5529 APC and SPFE

Figure 3-2 Components of a cluster 5529 APC deployment

Cluster 5529 APC deployment


5529 APC SPFE NE NE support plug-ins for other 5529 APC SPFE NE NE support plug-ins for other
NE support support 5529 Enhanced Applications NE support support 5529 Enhanced Applications
plug-ins plug-ins plug-ins plug-ins
Other 5529 Other 5529
5529 APC SPFE Enhanced Applications 5529 APC SPFE Enhanced Applications

5520 AMS 5520 AMS

JBoss application server JBoss application server

5520 AMS MySQL database 5520 AMS MySQL database

MySQL database server MySQL database server

Operating system Operating system

22479

3.2 Installing a single-server 5529 APC

This section describes how to install a 5529 APC in a single-server deployment on a


workstation. A single-server deployment means that the 5529 APC and 5520 AMS
are installed on the same workstation and share the same JBoss application server.
You can install the 5529 APC without interrupting the JBoss application server and
5520 AMS operations. See Table 2-1 for more information about the single-server
deployment model.

Software plug-in installation tasks


Procedure 3-1 provides the high-level steps to install the 5529 APC in a single-server
deployment.
Note 1 — You cannot activate a 5529 APC software plug-in or NE
support plug-in while the JBoss is initializing. You must activate the
plug-in before or after the JBoss has initialized. You can, however,
activate the plug-in while the JBoss is not running. Run the
ams_server status command to display the status of the JBoss, as
described in the 5520 AMS Installation and Migration Guide.
Note 2 — It can take up to two minutes to fully activate 5529 APC
software plug-in processes. There is a delay between activating the
5529 APC software plug-in and the ability to install the 5529 APC
NE support plug-ins.
Note 3 — It can take up to one minute to fully activate NE support
plug-in processes.

Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10 June 2014 3-5
3JL-02001-CAAA-RJZZA Edition 01
Installation and Customization Guide
3 — Install the 5529 APC and SPFE

Procedure 3-1 High-level procedure for single-server installation of


the 5529 APC
1 Install and activate the 5520 AMS in a standalone (simplex) configuration, as
described in the 5520 AMS Installation and Migration Guide.

2 Install and activate the 5529 APC software plug-in, the 5529 APC NE support
plug-ins, and the optional AVG plug-in container in the 5520 AMS server using
ams_install.sh; see the procedure in the 5520 AMS Installation and Migration
Guide to install a software plug-in for 5529 Enhanced Applications.

Note — You can also install and activate the SPFE software plug-in and
SPFE NE support plug-ins using the ams_install.sh script at this time;
however, the 5529 APC must be started successfully to connect to the
SPFE before you can use the SPFE GUI. See Section 3.6 for more
information about the SPFE software plug-in.

Alternatively, you can install and activate the SPFE software plug-in and
SPFE NE support plug-ins after the 5529 APC has been installed and
started successfully; see step 4.
The ams_install.sh script installs whichever of the 5529 APC software plug-ins
comes first in the list of plug-ins to install. The 5529 APC NE support plug-ins and
the AVG plug-in container are installed only after the 5529 APC software plug-in
has been installed. The AVG plug-in container is not mandatory. Install the AVG
plug-in container only if you plan to install AVG plug-ins.

An example of the 5529 APC software plug-in filename is


app-apc-APCrelease-workstation-AMSrelease-buildNumber-workstation

where
APCrelease-workstation is the release of the 5529 APC software that you are installing
AMSrelease is the release of the 5520 AMS software that you are installing
buildNumber is the build number of the software
workstation is solaris-sparc, solaris-x86, or redhat-x86_64

For example: app-apc-9.3.10.0_9.3.10-999000-solaris-sparc

See section 4.1 for a description of the 5529 APC NE support plug-in files.

Note — You can also install and activate the 5529 APC software plug-in
and the 5529 APC NE support plug-ins manually; see the 5520 AMS
Installation and Migration Guide.

3-6 June 2014 Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10
Edition 01 3JL-02001-CAAA-RJZZA
Installation and Customization Guide
3 — Install the 5529 APC and SPFE

3 Start the 5529 APC GUI for the first time as system administrator; see
Procedure 3-3.

4 If required, install the SPFE in the 5520 AMS, as described in Procedure 3-5. The
SPFE NE support plug-ins are installed when the ams_install.sh script is run.

Note — SPFE functionality only appears for the NEs for which plug-ins
have been installed and activated.

3.3 Installing a cluster 5529 APC

This section describes how to install a 5529 APC in a cluster deployment on multiple
server workstations. A cluster deployment means that the 5529 APC and 5520 AMS
are installed on the same workstation and share the same JBoss application server in
a cluster configuration. You can install the 5529 APC without interrupting the JBoss
application server and 5520 AMS operations. See Table 2-1 for more information
about the cluster deployment model.
Note — From the 5529 APC perspective, there is no distinction
between a single-server 5520 AMS and a single-server 5520 AMS
cluster.

In Figure 2-2, the primary and secondary 5520 AMS servers are labeled as such only
for the initiation of a connection with the 5520 AMS cluster from the 5529 APC.
These primary and secondary points of contact can be any two 5520 AMS servers in
the cluster. All 5520 AMS servers in the cluster are considered equal. The purpose
of having two server points of contact is for redundancy only. The 5529 APC
interacts with all of the 5520 AMS servers in the cluster when the connection to the
cluster is initiated through one of the points of contact.

HTTPS client connection to the cluster


See the 5520 AMS Solution Planning Guide for information about the HTTPS client
connection to the cluster.

JMS client connection to the cluster


The high-availability JMS service for APC notifications is available on all servers in
the cluster. It is not necessary to connect to the master application server to receive
notifications.
Figure 3-3 shows the JMS client connection to the cluster in a high-availability
configuration. See the 5529 Access Provisioning Center Northbound Interface
Specification Guide for information about configuring the JMS connection to the
cluster.

Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10 June 2014 3-7
3JL-02001-CAAA-RJZZA Edition 01
Installation and Customization Guide
3 — Install the 5529 APC and SPFE

Figure 3-3 Cluster 5529 APC deployment—JMS client connection to the cluster

JMS client

Subscription Notification

Subnetwork

Master application server server


server
20016

Software plug-in installation tasks


Procedure 3-2 provides the high-level steps to install the 5529 APC in a cluster
deployment.
Note 1 — You cannot activate a 5529 APC software plug-in or NE
support plug-in while the JBoss is initializing. You must activate the
plug-in before or after the JBoss has initialized. You can, however,
activate the plug-in while the JBoss is not running. Run the
ams_server status command to display the status of the JBoss, as
described in the 5520 AMS Installation and Migration Guide.
Note 2 — It can take up to two minutes to fully activate 5529 APC
software plug-in processes. There is a delay between activating the
5529 APC software plug-in and the ability to install the 5529 APC
NE support plug-ins.
Note 3 — It can take up to one minute to fully activate NE support
plug-in processes.

Procedure 3-2 High-level procedure for cluster installation of the


5529 APC
1 Install and activate the 5520 AMS in a cluster configuration, as described in the
5520 AMS Installation and Migration Guide.

2 Perform steps 3 to step 5 for each 5520 AMS server in the cluster.

Note — You must allow the active 5529 APC server to activate
completely before activating the standby 5529 APC servers.

3-8 June 2014 Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10
Edition 01 3JL-02001-CAAA-RJZZA
Installation and Customization Guide
3 — Install the 5529 APC and SPFE

3 Install and activate the 5529 APC software plug-in, the 5529 APC NE support
plug-ins, and the optional AVG plug-in container in the 5520 AMS server using
ams_install.sh; see the procedure in the 5520 AMS Installation and Migration
Guide to install a software plug-in for 5529 Enhanced Applications.

Note — You can also install and activate the SPFE software plug-in and
SPFE NE support plug-ins using the ams_install.sh script at this time;
however, the 5529 APC must be started successfully to connect to the
SPFE before you can use the SPFE GUI. See Section 3.6 for more
information about the SPFE software plug-in.

Alternatively, you can install and activate the SPFE software plug-in and
SPFE NE support plug-ins after the 5529 APC has been installed and
started successfully; see step 5.
The ams_install.sh script installs whichever of the 5529 APC software plug-ins
comes first in the list of plug-ins to install. The 5529 APC NE support plug-ins and
the AVG plug-in container are installed only after the 5529 APC software plug-in
has been installed. The AVG plug-in container is not mandatory. Install the AVG
plug-in container only if you plan to install AVG plug-ins.

An example of the 5529 APC software plug-in filename is


app-apc_APCrelease-workstation_AMSrelease-revisionNumber-workstation.bin:

where
APCrelease-workstation is the release of the 5529 APC software that you are installing
AMSrelease is the release of the 5520 AMS software that you are installing
revisionNumber is the revision number of the software
workstation is solaris-sparc, solaris-x86, or redhat-x86_64

For example: app-apc-9.3.10.0_9.3.10-999000-solaris-sparc.bin. See section 4.1


for a description of the 5529 APC NE support plug-in files.

Note — You can also install and activate the 5529 APC software plug-in
and the 5529 APC NE support plug-ins manually; see the 5520 AMS
Installation and Migration Guide.

4 Start the 5529 APC GUI for the first time as system administrator; see
Procedure 3-3.

5 If required, install the SPFE in the 5520 AMS, as described in Procedure 3-5. The
SPFE NE support plug-ins are installed when the ams_install.sh script is run.

Note — SPFE functionality only appears for the NEs for which SPFE
plug-ins have been installed and activated.

Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10 June 2014 3-9
3JL-02001-CAAA-RJZZA Edition 01
Installation and Customization Guide
3 — Install the 5529 APC and SPFE

3.4 Starting the 5529 APC GUI for the first time as the system
administrator

This section describes how to start the 5529 APC GUI for the first time as the system
administrator, including adding the license key and synchronizing providers.
See the 5520 AMS Administrator Guide for information about logging in to the
5520 AMS GUI and changing user settings.
Note — For a cluster deployment, each server in the cluster must
have access to the same URL NE provider file through the shared
directory (default is /var/tmp).

Procedure 3-3 To start the 5529 APC GUI for the first time as the
system administrator

This procedure provides the steps to:

• start the 5529 APC GUI


• synchronize the 5529 APC and URL providers

Before you proceed, see the 5520 AMS Installation and Migration Guide for information
about how to start the 5520 AMS server.

1 Open a Web browser and navigate to http://server:port number

where
server is the name of the 5520 AMS server
port number is the port number for the Web server

For example: http://amsserver:8080

2 Depending on the browser, one or more security certificates may appear. Click on
the Yes or OK button to continue.

The login prompt is displayed in the Access Provisioning Center login window, as
shown in Figure 3-4.

3-10 June 2014 Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10
Edition 01 3JL-02001-CAAA-RJZZA
Installation and Customization Guide
3 — Install the 5529 APC and SPFE

Figure 3-4 Access Provisioning Center login window

3 Enter the username and password.

Note — Contact your Alcatel-Lucent technical support representative


for the default username and password.

4 Click on the Log in button. The About window will appear if a valid APC license
has not been installed.

5 Add the 5529 APC license in the 5520 AMS. Install the license in the 5520 AMS
directly; see the 5520 AMS Installation and Migration Guide for more information.

Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10 June 2014 3-11
3JL-02001-CAAA-RJZZA Edition 01
Installation and Customization Guide
3 — Install the 5529 APC and SPFE

6 Change the administrator password.

i Choose Administration→User management from the 5529 APC main menu.


The User management window opens, as shown in Figure 3-5.

Figure 3-5 User management window

ii Click on the admin hyperlink. The User properties window opens.

iii Set the Password and Confirm Password parameters.

iv Click on the OK button.

7 Choose Administration→System settings from the 5529 APC main menu. The
System settings window opens, as shown in Figure 3-6.

3-12 June 2014 Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10
Edition 01 3JL-02001-CAAA-RJZZA
Installation and Customization Guide
3 — Install the 5529 APC and SPFE

Figure 3-6 System settings window

8 Configure the parameters.

See the 5529 Access Provisioning Center User Guide for parameter information.

9 Click on the APC tab and configure the parameters. See the 5529 Access
Provisioning Center User Guide for parameter information.

10 Add a URL provider:

i Choose Configuration→Synchronization from the 5529 APC main menu. The


NE providers window opens.

ii Click on the Add URL provider button. The URL NE provider editor window
opens.

iii Configure the parameters, which are described in Table 3-2. Both
parameters are mandatory, as denoted with an asterisk (*).

Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10 June 2014 3-13
3JL-02001-CAAA-RJZZA Edition 01
Installation and Customization Guide
3 — Install the 5529 APC and SPFE

Table 3-2 URL NE provider parameters

Parameter Description Options

Provider Specifies the name Enter a unique name


name * for the list of servers

URL * Specifies the location URL, for example:


of the servers https://myserver/dslams.csv
https://username:password@myserver/dslams.csv
The format for the file is comma-separated with the
following information:
ASAM name (mandatory)
ASAM IP address (mandatory)
ASAM SNMP port (optional, default is 161)
ASAM SNMP read-community (optional, default is public)
ASAM SNMP write-community (options, default is public)
For example:
DSLAM1,192.168.13.51
or
DSLAM2,192.168.13.52,5161,test,test
If you do not use the default values, you must specify a
value for all the optional parameters in the order listed
above.
To test the URL, enter the URL in a browser. Note that the
server for the URL may have different access privileges than
the access privileges for the workstation.

iv Click on the OK button. The URL provider is displayed in the providers list.

11 Click on the Synchronize NEs button to synchronize the providers. See the
5529 Access Provisioning Center User Guide for more information about providers
and synchronization.

Note — Alcatel-Lucent recommends that you synchronize when new


NEs are added or configure daily automatic synchronizations of the
5529 APC and providers. See the 5529 Access Provisioning Center User
Guide for more information about configuring automatic
synchronizations.

3.5 Logging out of the 5529 APC GUI

Procedure 3-4 To log out of the 5529 APC GUI

Click on the Logout icon ( ) in the top right corner of the 5529 APC GUI window to log
out of the 5529 APC GUI.

3-14 June 2014 Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10
Edition 01 3JL-02001-CAAA-RJZZA
Installation and Customization Guide
3 — Install the 5529 APC and SPFE

3.6 Installing the SPFE

Note — You must install the 5529 APC before you install the SPFE;
see Procedures 3-1 and 3-2.

Procedure 3-5 provides the steps to install the optional SPFE. Table 2-1 lists the
5529 APC deployment models that support SPFE. See the 5529 Access Provisioning
Center Service Provisioning Front End Guide for more information about the SPFE.

Caution — You must uninstall the previous SPFE before you install
a new SPFE; see the procedure in the 5520 AMS Installation and
Migration Guide to uninstall a plug-in for 5529 Enhanced
Applications.

Note 1 — If you have SPFE installed, stopping the 5520 AMS server
disconnects the SPFE. After starting the 5520 AMS server, you must
log in to SPFE again.
Note 2 — SPFE functionality only appears for the NEs for which
plug-ins have been installed and activated.

Procedure 3-5 To install the SPFE

Before you proceed:

• install the 5529 APC; see Procedure 3-1 and Procedure 3-2
• start the 5529 APC GUI for the first time as the system administrator; see
Procedure 3-3

1 Log in to the 5520 AMS server as amssys, as described in the 5520 AMS Installation
and Migration Guide, and open a terminal window.

2 FTP the SPFE .bin file to the server workstation.

3 To change the owner of the files to amssys and change the permissions for the file,
type:

chown amssys:amssys spfe_file.bin ↵

chmod 755 spfe_file.bin ↵

where spfe_file is the name of the SPFE .bin file; for example,
app-spfe_9.3.10.0_9.3.10-999000-solaris-sparc.bin,
app-spfe_9.3.10.0_9.3.10-999000-solaris-x86.bin, or
app-spfe_9.3.10.0_9.3.10-999000-redhat-x86_64.bin

4 Type:

./spfe_file.bin ↵

The SPFE plug-in is installed.

Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10 June 2014 3-15
3JL-02001-CAAA-RJZZA Edition 01
Installation and Customization Guide
3 — Install the 5529 APC and SPFE

5 Activate the SPFE plug-in by typing:

$AMS_LOCAL_DATA_DIR/ams/local/repository/app-spfe_release-workst
ation/bin/activate.sh ↵

where
release is the release of the 5529 APC and 5520 AMS software; for example,
9.3.10.0_9.3.10-999000
workstation is solaris-sparc, solaris-x86, or redhat-x86 (release 9.2.20 or later only); for example,
9.3.10.0_9.3.10-999000-solaris-sparc

6 Install the SPFE NE support plug-ins for the 5529 APC; see the 5520 AMS
Installation and Migration Guide.

7 Activate the SPFE NE support plug-ins; see the 5520 AMS Installation and
Migration Guide.

8 Perform one of the following:

a If you have uninstalled previous SPFE plug-ins and are installing new SPFE
plug-ins, go to step 9.

b If you are installing SPFE plug-ins on the server for the first time, go to
step 11.

9 Uninstall the 5520 AMS client; see the 5520 AMS Installation and Migration Guide.

10 Install the 5520 AMS client; see the 5520 AMS Installation and Migration Guide.

11 Launch and update the 5520 AMS client; see the 5520 AMS Installation and
Migration Guide.

12 Start the SPFE GUI and configure the administrative settings; see the 5529 Access
Provisioning Center Service Provisioning Front End Guide.

13 Configure a user account with an SPFE User profile in the 5529 APC Web GUI to
allow an SPFE user on the 5520 AMS to perform operations in the 5529 APC Web
GUI using the SPFE Service Template Overview window; see the 5529 Access
Provisioning Center User Guide.

3.7 Logging in to the 5529 APC as an amssys user

Procedure 3-6 provides the steps to log in to the 5529 APC server workstation as an
amssys user. Before you proceed, you need an amssys password. See section 3.1 for
information about default passwords.

3-16 June 2014 Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10
Edition 01 3JL-02001-CAAA-RJZZA
Installation and Customization Guide
3 — Install the 5529 APC and SPFE

Procedure 3-6 To log in to the 5529 APC server as an amssys user


1 Log in to the 5529 APC server workstation as the amssys user by performing one of
the following:

a If you are logged in as a root user, switch to the amssys user by typing:

su - amssys ↵

b If you are not logged in, telnet to the 5529 APC server workstation and log in
as amssys.

2 Enter the amssys password if a prompt appears. The default password is amssys.

Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10 June 2014 3-17
3JL-02001-CAAA-RJZZA Edition 01
Installation and Customization Guide
3 — Install the 5529 APC and SPFE

3-18 June 2014 Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10
Edition 01 3JL-02001-CAAA-RJZZA
Installation and Customization Guide
Managing plug-ins

4 — Manage NE support plug-ins

5 — Manage AVG plug-ins

Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10 June 2014


3JL-02001-CAAA-RJZZA Edition 01
Installation and Customization Guide
June 2014 Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10
Edition 01 3JL-02001-CAAA-RJZZA
Installation and Customization Guide
4— Manage NE support plug-ins

4.1 NE support plug-in management overview 4-2

4.2 NE support plug-in management tasks 4-3

Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10 June 2014 4-1
3JL-02001-CAAA-RJZZA Edition 01
Installation and Customization Guide
4 — Manage NE support plug-ins

4.1 NE support plug-in management overview

The 5529 APC requires NE support plug-ins to be installed to allow service


provisioning on the related NE types. The NE support plug-ins must support the NE
type releases that are to be managed. The 5529 APC NE support plug-ins are
different from the 5520 AMS NE support plug-ins and the NE support plug-ins for
other 5529 Enhanced Applications.
You can install or upgrade NE support plug-ins in the 5529 APC without interrupting
the operation of the 5529 APC and 5520 AMS. NE support plug-ins are installed or
upgraded if they support new NEs, new NE releases, or new NE functionality. The
plug-in framework minimizes management risks and downtime. In general, a restart
of the 5520 AMS server or database migration is not required.
NE support plug-ins for 7342 ISAM FTTU, GENBAND G6, and 7302 ISAM, 7302
ISAM xVPS, 7330 ISAM FTTN (Release 4.3 or later only), 7356 ISAM FTTB, and
7360 ISAM FX are available by release for NE plug-ins released after 5529 APC
Release 9.1.0, whereas NE support plug-ins for 7302 ISAM, 7302 ISAM xVPS, and
7330 ISAM FTTN prior to Release 4.3 are available by NE family, regardless of the
NE release.

Note — The installation and upgrade of NE support plug-ins are


regular maintenance procedures; however, you must continue to see
the 5529 APC Customer Release Notice for additional information.
Before you permanently remove NE support plug-ins, contact your
Alcatel-Lucent technical support representative for assistance. The
permanent removal of NE support plug-ins can affect 5529 APC
system integrity.

Table 4-1 lists the binary installation files for the 5529 APC NE support plug-ins.
See the 5529 APC Customer Release Notice for the supported NE releases and
plug-in versions.

Table 4-1 NE support plug-in binary installation files

Supported NEs Package names

7302 ISAM Release-specific plug-ins (for Release 4.3 or later):


7302 ISAM xVPS plugin-apc-isam-supported release.bin, where supportedrelease is the
7330 ISAM FTTN ISAM release, the plug-in version, and the 5529 APC software release
7356 ISAM FTTB (for Product family plug-ins (for releases prior to Release 4.3):
Release 4.2 or later) plugin-apc-730x-x.x-1.0-supported release, where supported release is
7360 ISAM FX (for the 5520 AMS release, the 5529 APC release, and the 5529 APC software
Release 4.3 or later) release

7342 ISAM FTTU Release-specific plug-ins:


plugin-apc-gpon-supportedrelease.bin, where supportedrelease is the
7342 ISAM FTTU release, the plug-in version, and the 5529 APC software
release

GENBAND G6 Release-specific plug-ins:


plugin-apc-g6-supportedrelease.bin, where supportedrelease is the
GENBAND G6 release, the plug-in version, and the 5529 APC software
release

(1 of 2)

4-2 June 2014 Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10
Edition 01 3JL-02001-CAAA-RJZZA
Installation and Customization Guide
4 — Manage NE support plug-ins

Supported NEs Package names

Bind template plugin-apc-g6g7342-release.bin, where release is the plug-in version and


software release
Provides the end-to-end G6 to 7342 ISAM FTTU voice service plug-in at
installation.

(2 of 2)

SPFE NE support plug-ins


Like NE support plug-ins, SPFE NE support plug-ins must be installed for SPFE
functionality to be available for each NE type and release. The SPFE NE support
plug-ins are managed, installed, and uninstalled in the same way as other NE support
plug-ins.
Table 4-2 lists the binary installation files for the SPFE NE support plug-ins. See the
5529 Access Provisioning Center Customer Release Notice for the supported NE
releases and plug-in versions.

Table 4-2 SPFE NE support plug-in binary installation files

Supported NEs Package names


7302 ISAM Release-specific plug-ins (for Release 4.3 or later):
7302 ISAM xVPS plugin-spfe-isam-supportedrelease.bin, where supportedrelease is the
7330 ISAM FTTN ISAM release, the plug-in version and 5529 APC software release
7356 ISAM FTTB (for Product family plug-ins (for releases prior to Release 4.3):
Release 4.2 or later) plugin-spfe-730x-x.x-1.0-supported release, where supported release is
7360 ISAM FX (for the 5520 AMS release, the 5529 APC release, and the 5529 APC software
Release 4.3 or later) release

7342 ISAM FTTU plugin-spfe-gpon-supportedrelease.bin, where supportedrelease is the


7342 ISAM FTTU release, the plug-in version and 5529 APC software release

GENBAND G6 plugin-spfe-g6-supportedrelease.bin, where supportedrelease is the


GENBAND G6 release, the plug-in version and 5529 APC software release

4.2 NE support plug-in management tasks

Table 4-3 lists the NE support plug-in management tasks.

Table 4-3 NE support plug-in management tasks

Task (1) (2) (3) See

Install and activate an NE support plug-in or SPFE NE support 5520 AMS Installation and Migration
plug-in Guide

Uninstall an NE support plug-in or SPFE NE support plug-in Section 8.2

Migrate an NE support plug-in or SPFE NE support plug-in 5520 AMS Installation and Migration
Guide

(1 of 2)

Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10 June 2014 4-3
3JL-02001-CAAA-RJZZA Edition 01
Installation and Customization Guide
4 — Manage NE support plug-ins

Task (1) (2) (3) See


View installed NE support plug-ins and SPFE NE support 5520 AMS User Guide
plug-ins in the 5520 AMS GUI

(2 of 2)

Notes
(1) In a cluster deployment, the same NE support plug-ins must be installed in each server in the
5520 AMS cluster.
(2) You cannot activate or deactivate a 5529 APC NE support plug-in while the JBoss is initializing. You
must activate or deactivate the plug-in before or after the JBoss has initialized. You can, however,
activate or deactivate the plug-in while the JBoss is not running. Run the ams_server status
command to display the status of the JBoss, as described in the 5520 AMS Installation and
Migration Guide.
(3) It can take up to one minute to fully activate or deactivate NE support plug-in processes. There is
a delay between activating or deactivating the 5529 APC NE support plug-ins using these
procedures and the ability to perform the next step in the procedure.

4-4 June 2014 Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10
Edition 01 3JL-02001-CAAA-RJZZA
Installation and Customization Guide
5— Manage AVG plug-ins

5.1 AVG plug-in management overview 5-2

5.2 Installing the AVG plug-in container 5-3

5.3 Installing, activating, and upgrading AVG plug-ins 5-4

5.4 Uninstalling an AVG plug-in 5-6

Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10 June 2014 5-1
3JL-02001-CAAA-RJZZA Edition 01
Installation and Customization Guide
5 — Manage AVG plug-ins

5.1 AVG plug-in management overview

You can use the AVG plug-in container to create and manage plug-ins which
auto-generate template argument values. You can install and uninstall the AVG
plug-in container, and add and delete plug-ins in the 5529 APC without interrupting
the operation of the 5529 APC and 5520 AMS. The plug-in container minimizes
management risks and downtime. A restart of the 5520 AMS server or database
migration is generally not required.

Note — AVG plug-ins run as part of the 5529 APC system. As such,
plug-in design can affect 5529 APC performance, stability, and
security. As AVG is typically project specific, AVG plug-ins are
assumed to have been developed by the customer or by a third-party
contracted by the customer. AVG plug-ins can also be developed by
Alcatel-Lucent provided there is a specific agreement and Statement
of Work. Alcatel-Lucent assumes no responsibility for problems with
5529 APC that arise from problems with a plug-in developed by
customers or third parties contracted by the customer.

AVG plug-in management window


The 5529 APC Web GUI provides an AVG Plugin management window to display
the AVG plug-ins that are installed in the 5529 APC server. In a cluster deployment,
you must view the AVG Plugin management window in each 5529 APC server in the
cluster to monitor the plug-ins for the cluster. See the 5529 Access Provisioning
Center User Guide for information about how to display the AVG Plugin
management window. Figure 5-1 shows the AVG Plugin management window.

Figure 5-1 AVG Plugin management window

AVG plug-in management tasks


Table 5-1 lists the AVG plug-in management tasks.

5-2 June 2014 Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10
Edition 01 3JL-02001-CAAA-RJZZA
Installation and Customization Guide
5 — Manage AVG plug-ins

Table 5-1 AVG plug-in management tasks

Task See

Install the AVG plug-in container Section 5.2


In a cluster deployment, the same AVG plug-ins must be installed in each server in
the 5520 AMS cluster

Install and activate AVG plug-ins Section 5.3

Upgrade AVG plug-ins Section 5.3

Uninstall an AVG plug-in Section 8.3

5.2 Installing the AVG plug-in container

Use the following procedure to install the AVG plug-in container.


Before you proceed:
• The 5529 APC needs to be installed and activated.
• You need a binary installation file for the AVG plug-in container that you are
installing in the 5520 AMS server.
• You need to be able to log in to the server as amssys.

Procedure 5-1 To install an AVG plug-in container


1 Log in to the 5520 AMS server workstation as amssys.

2 Copy the plugin-apc-avgnoplugs_release.bin binary installation file to a directory


on each server in the cluster, where release is the version and release of the AVG;
for example, plugin-apc-avgnoplugs-1.0-1.0_9.3.10_9.3.10-999000.bin.

3 Modify the permissions on the binary installation file to make the file executable
by typing:

chmod 555 /directory/file_name ↵

where
directory is the directory where you placed the plug-in .bin files in step 2
file_name is the name of the binary installation file for the AVG plug-in

4 Run the AVG plug-in container installation file by typing:

/directory/file_name ↵

where
directory is the directory where you placed the plug-in .bin files in step 2
file_name is the name of the binary installation file for the AVG plug-in

Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10 June 2014 5-3
3JL-02001-CAAA-RJZZA Edition 01
Installation and Customization Guide
5 — Manage AVG plug-ins

The installer indicates when the installation is complete.

Note — If you install the 5529 APC server but do not activate it, the
system displays an error message indicating that a repository for the
plug-in data cannot be identified. Activate the 5529 APC server and
repeat step 4.

5.3 Installing, activating, and upgrading AVG plug-ins

When you install the plug-in container, you must install the AVG plug-ins in it.
When installed, they plug-ins are in a passive, standby mode until you activate them.
When you activate the plug-ins, the files are placed in a location where they are
started by the JBoss server.
You must install and activate the AVG plug-ins to be able to use them in a template.
You can also create additional plug-ins and install and activate them. Specify a name
for each AVG formula plug-in you create using the naming convention
apc-avg-plug-name-version.sar, where:
• name is the name of the plug-in
• version is the version of the plug-in
Before you proceed:
• You need to be able to log in to the server as amssys.
• You need to install the AVG container before the plug-ins are installed; see
Procedure 5-1.

5-4 June 2014 Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10
Edition 01 3JL-02001-CAAA-RJZZA
Installation and Customization Guide
5 — Manage AVG plug-ins

Procedure 5-2 To install and activate AVG plug-ins

Use this procedure to activate one or more AVG plug-ins.

Caution — AVG plug-in installation may be service affecting.

Note — You cannot activate a 5529 APC AVG plug-in while the JBoss is
initializing. You must activate the plug-in before or after the JBoss has
initialized. You can, however, activate the plug-in while the JBoss is not
running. Run the ams_server status command to display the status of
the JBoss, as described in the 5520 AMS Installation and Migration
Guide.
1 Log in to the server as amssys.

2 Place each AVG plug-in that you need to activate in the


$AMS_LOCAL_DATA_DIR/ams/local/repository/plugin-apc-avg*/apc-avg*/
directory.

3 Determine whether any AVG plug-ins are currently in use.

a If no AVG plug-ins are currently in use in deployed templates, go to step 4.

b If AVG plug-ins are currently in use in deployed templates, go to step 5.

4 Run the AVG plug-in activation script by typing:

$AMS_LOCAL_DATA_DIR/ams/local/repository/plugin-apc-avg*/bin/act
ivate.sh ↵

5 Run the AVG plug-in reactivation script by typing:

$AMS_LOCAL_DATA_DIR/ams/local/repository/plugin-apc-avg*/bin/rea
ctivate.sh ↵

The reactivate script compares the list of AVG plug-ins identified in the
$AMS_LOCAL_DATA_DIR/ams/local/repository/plugin-apc-avg*/apc-avg*/
directory with those deployed in JBoss and deploys only those plug-ins not
currently deployed. This ensures that there is no service impact to AVG plug-ins
currently in use.

6 In a cluster deployment model, repeat steps 1 to 5 on each server in the cluster.

Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10 June 2014 5-5
3JL-02001-CAAA-RJZZA Edition 01
Installation and Customization Guide
5 — Manage AVG plug-ins

Procedure 5-3 To upgrade AVG plug-ins

Use this procedure to upgrade one or more AVG plug-ins without affecting any other
AVG plug-ins.

1 Log in to the server as amssys.

2 Delete the old AVG plug-in from the following directory:

$AMS_LOCAL_DATA_DIR/ams/local/repository/plugin-apc-avg*/apc-avg
*/

3 Add the upgraded AVG plug-in to the following directory:

$AMS_LOCAL_DATA_DIR/ams/local/repository/plugin-apc-avg*/apc-avg
*/

4 Execute the reactivate script, by typing:

$AMS_LOCAL_DATA_DIR/ams/local/repository/plugin-apc-avg*/bin/rea
ctivate.sh ↵

5.4 Uninstalling an AVG plug-in

For information about uninstalling an AVG plug-in, see section 8.3.

5-6 June 2014 Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10
Edition 01 3JL-02001-CAAA-RJZZA
Installation and Customization Guide
Migrating

6 — Migrate the 5529 APC

7 — Migrate NEs from 5523 AWS to 5520 AMS

Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10 June 2014


3JL-02001-CAAA-RJZZA Edition 01
Installation and Customization Guide
June 2014 Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10
Edition 01 3JL-02001-CAAA-RJZZA
Installation and Customization Guide
6— Migrate the 5529 APC

6.1 5529 APC migration overview 6-2

6.2 5529 APC and 5520 AMS migration from Release 9.3.0, 9.2.30,
and 9.2.10 6-3

Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10 June 2014 6-1
3JL-02001-CAAA-RJZZA Edition 01
Installation and Customization Guide
6 — Migrate the 5529 APC

6.1 5529 APC migration overview

This section describes how to perform the 5529 APC migrations.


The 5529 APC Release 9.3.10 provides support for migration from the 5529 APC
Releases 9.3.0, 9.2.30, and 9.2.10.
You must migrate to 5529 APC Release 9.3.0, 9.2.30, 9.2.10 from earlier releases
before you can migrate to Release 9.3.10 or later. See the 5529 Access Provisioning
Center Installation and Customization Guide for Release 9.3.0, 9.2.30, or 9.2.10 for
more information.
For information about migrating from an earlier 5529 APC release to Release 9.3.0,
9.2.30, or 9.2.10, see the 5529 Access Provisioning Center Installation and
Customization Guide for those releases.
Table 6-1 describes the support for upgrades between the SPARC and x86
architectures.

Table 6-1 5529 APC upgrade support between operating systems and architectures

From To

Operating system and Release Operating system and Release


architecture architecture

Solaris SPARC 9.2.30 x86 9.3.10


9.3.0
Solaris SPARC 9.2.30 Red Hat Enterprise Linux x86 9.3.10
9.3.0
9.3.10

Solaris SPARC 9.2.10 Solaris SPARC 9.3.10


9.2.30
9.3.0

x86 9.2.30 x86 9.3.10


9.3.0
x86 9.2.30 Red Hat Enterprise Linux x86 9.3.10
9.3.0
9.3.10

After a migration, you can add NE support plug-ins to support new NE releases, as
described in chapter 4.

Data migration
The following data is migrated:
• NE administrative data
• templates

6-2 June 2014 Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10
Edition 01 3JL-02001-CAAA-RJZZA
Installation and Customization Guide
6 — Migrate the 5529 APC

• operators
• APC system parameters

Note 1 — The 5529 APC license must be renewed in the 5520 AMS
as part of the migration.
Note 2 — In 5529 APC, Release 9.1.0 or later, a new database table
has been introduced to save the relationship between basic templates
and their parent service stack. When migrating from earlier 5529 APC
releases to 5529 APC, Release 9.1.0 or later, the table is populated
during migration. For the table to be populated, the basic service
templates in 5529 APC must be aligned with its parent service stacks.
Misaligned services are not migrated and an error message stating that
the migration failed for a given service is recorded in a log file. These
services should be aligned before the migration takes place.
Alcatel-Lucent can provide a tool to help identify these services.
Contact Alcatel-Lucent for more information.

The NE support plug-ins do not contain data that requires migration.

6.2 5529 APC and 5520 AMS migration from Release 9.3.0,
9.2.30, and 9.2.10

For the 5529 APC and 5520 AMS to work together, the 5529 APC and 5520 AMS
releases must be aligned. For example, 5529 APC, Release 9.3.10, works with
5520 AMS, Release 9.3.0. For information about which 5529 APC releases align
with the 5520 AMS releases, see the 5529 APC product roadmap and the 5520 AMS
Customer Release Notice.

Note — You must migrate to 5529 APC Release 9.3.0, 9.2.30, and
9.2.10 from earlier releases before you can migrate to Release 9.3.10
or later. See the 5529 Access Provisioning Center Installation and
Customization Guide for Release 9.3.0, 9.2.30, or 9.2.10 for more
information.

Required resources and applications for 5529 APC migration


The following resources and applications are required:
• 5520 AMS server that is running the Solaris 10 operating system
• 5520 AMS server that has enough disk space to store the exported 5529 APC data
and new 5529 APC installation. See section 2.3 for more information about
system requirements.
• 5529 APC license keys for the target 5529 APC release
• 5520 AMS data copying script: ams_copy_datafiles script

Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10 June 2014 6-3
3JL-02001-CAAA-RJZZA Edition 01
Installation and Customization Guide
6 — Migrate the 5529 APC

Preparing to migrate the 5529 APC


Before you proceed with the migration of a 5529 APC, perform the following tasks:
• Clean up the system by removing all unnecessary 5529 APC configurations. For
example, delete unused NEs, operators, and templates.
• Perform a full backup of the 5520 AMS database, as described in the 5520 AMS
Administrator Guide. The 5529 APC data is backed up and restored when the
5520 AMS is backed up and restored. In a cluster deployment, backing up the
standby data server enables you to perform the backup while the 5520 AMS and
5529 APC continue to operate.
• Ensure that you have enough disk space to export the database information.

Note — Alcatel-Lucent recommends that you perform a


network-wide audit and take the necessary reconciliation actions
before a major migration.

Migrating the 5529 APC


For migration from Release 9.3.0, 9.2.30, or 9.2.10 to Release 9.3.10, data files for
the 5520 AMS, 5529 Enhanced Applications, and NE support plug-ins are copied by
running the ams_copy_datafiles script on the data server. The script copies data from
a backup file, any previously installed releases on the same machine, or the
previously active release on the server (the default setting).
In a cluster migration, the ams_copy_datafiles script needs to be run on the master
data server in the cluster.
The ams_copy_datafiles script can be run in one of two modes:
• interactive
• non-interactive
The interactive mode requires you to interact with the script and respond to a series
of command line prompts as the script is running. The non-interactive mode allows
you to provide a set of command line parameters up front when you run the script
and not have to interact with the script while it is running. The parameters provide
the same data that you would provide at the prompts in the interactive mode.
The amssys or root user can run the ams_copy_datafiles script.
Two migration strategies are supported:
• in-place migration
• out-of-place migration
In-place migration refers to migration to a new release on the same machine where
the earlier release is installed. Out-of-place migration refers to migration to a new
release on a server which is different from the server where the earlier release is
installed.

6-4 June 2014 Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10
Edition 01 3JL-02001-CAAA-RJZZA
Installation and Customization Guide
6 — Migrate the 5529 APC

See the 5520 AMS Installation and Migration Guide for information about how to
migrate the 5529 APC from Release 9.3.0, 9.2.30, or 9.2.10 to Release 9.3.10.

Caution — For Release 9.2.30 and later, the 5529 APC NE support
plug-ins must be installed and activated only after the corresponding
5520 AMS NE support plug-ins have been installed and activated.
Otherwise, the installation of the 5529 APC NE support plug-ins will
fail.

Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10 June 2014 6-5
3JL-02001-CAAA-RJZZA Edition 01
Installation and Customization Guide
6 — Migrate the 5529 APC

6-6 June 2014 Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10
Edition 01 3JL-02001-CAAA-RJZZA
Installation and Customization Guide
7— Migrate NEs from 5523 AWS to
5520 AMS

7.1 Overview of NE migration from 5523 AWS to 5520 AMS 7-2

7.2 Adding an EML provider 7-2

7.3 Migrating NEs from 5523 AWS to 5520 AMS offline from
5529 APC 7-3

7.4 Migrating NEs from 5523 AWS to 5520 AMS online with
5529 APC 7-4

7.5 Migrating NEs from 5520 AMS to 5523 AWS online with
5529 APC 7-5

Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10 June 2014 7-1
3JL-02001-CAAA-RJZZA Edition 01
Installation and Customization Guide
7 — Migrate NEs from 5523 AWS to 5520 AMS

7.1 Overview of NE migration from 5523 AWS to 5520 AMS

You can migrate NEs to the 5520 AMS, Release 8.3.0 or later, from the 5523 AWS,
Release 7.2.2 or Release 7.2.3 platform. If you have the 5529 APC installed, you can
perform the NE migration under the following conditions:
• migration is offline from the 5529 APC
• migration is online with the 5529 APC and NEs can be added to the 5529 APC in
real time

During online migration the 5529 APC can continue to be used to configure services
on the NEs during the migration process, whereas during offline migration the
5529 APC cannot continue to be used to configure services on the NEs during the
migration process.
You can also migrate NEs from the 5520 AMS back to the 5523 AWS, if necessary.
The NE migration is performed online with the 5529 APC and the NEs are
synchronized manually with the 5529 APC after the migration is complete.
Note 1 — Only NEs for which you have 5520 AMS and 5529 APC
plug-ins are migrated.
Note 2 — You can retrieve a list of 5520 AMS managed NEs that can
be provisioned by the 5529 APC by filtering on managed NE type and
release.

7.2 Adding an EML provider

The 5529 APC is synchronized with the AWS EML provider for the 5529 APC to
discover the NEs that are managed by the 5523 AWS.
Note 1 — EML provider configurations apply only to the 5523 AWS
and not to 5520 AMS-managed NEs.
Note 2 — If you are migrating the 5529 APC and moving support of
NEs from one EMS to another EMS, which requires that the specified
EML provider be updated in the 5529 APC GUI, Alcatel-Lucent
recommends that you fully complete the migration of the 5529 APC
before you move support of the NEs to another EMS. The 5529 APC
is completely operational only when the EML provider is migrated
successfully for the corresponding supported release.

Procedure 7-1 To add an EML provider


1 Choose Configuration→Synchronization from the 5529 APC main menu. The NE
providers window opens.

2 Click on the Add EML provider button. The EML NE provider editor window opens.

3 Configure the parameters, as described in Table 7-1. The Provider name is a


mandatory parameter, as denoted with an asterisk (*).

7-2 June 2014 Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10
Edition 01 3JL-02001-CAAA-RJZZA
Installation and Customization Guide
7 — Migrate NEs from 5523 AWS to 5520 AMS

Table 7-1 EML provider parameters

Parameter Description Options

EMS Type Specifies the release of the EML AWS R7: specifies a 5523 AWS, R7.2.x or
provider. earlier; this parameter cannot be
configured

Provider name * Specifies the host name or IP The host name or IP address of the EML
address of the EML provider. provider.
In a 5520 AMS cluster In a 5520 AMS cluster configuration, the
configuration, specifies the host name or IP address of the primary
primary cluster server. 5520 AMS cluster server local host.
Alcatel-Lucent recommends using 0.0.0.0
or localhost. The backup provider name is
not required.

EML user account Name of the EML provider user Enter characters. The account name must
account match the name of the user account on the
EML provider. The default account is the
account set by the EML user account
parameter in the 5529 APC system settings.
EML user Password for the EML provider Enter characters. The account password
password user account must match the password of the user
account on the EML. The default account is
the account set by the EML user account
parameter in the 5529 APC system settings.

4 Click on the OK button. The EML provider is displayed in the providers list.

5 Click on the Synchronize NEs button to synchronize the providers. See the
5529 Access Provisioning Center User Guide for more information about providers
and synchronization.

Note — Alcatel-Lucent recommends that you synchronize when new


NEs are added or configure daily automatic synchronizations of the
5529 APC and providers. See the 5529 Access Provisioning Center User
Guide for more information about configuring automatic
synchronizations.

7.3 Migrating NEs from 5523 AWS to 5520 AMS offline from
5529 APC

Procedure 7-2 provides the steps to migrate NEs from the 5523 AWS platform to the
5520 AMS platform while offline from the 5529 APC.

Note — Alcatel-Lucent recommends that you perform this procedure


when the activity of the 5529 APC server is low, for example, at
midnight, as the EMS is taken offline from the 5529 APC.

Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10 June 2014 7-3
3JL-02001-CAAA-RJZZA Edition 01
Installation and Customization Guide
7 — Migrate NEs from 5523 AWS to 5520 AMS

Procedure 7-2 To migrate NEs from 5523 AWS to 5520 AMS offline
from 5529 APC
1 Synchronize the 5523 AWS EML provider and the 5529 APC, as described in the
5529 Access Provisioning Center User Guide.

2 Migrate the NEs from the 5523 AWS to the 5520 AMS.

3 Delete the migrated NEs from the 5523 AWS, as described in the 5523 AWS ANEL
User Guide and 5523 AWS Operator Guide.

4 Delete the 5523 AWS EML provider from the 5529 APC, as described in the
5529 Access Provisioning Center User Guide.

7.4 Migrating NEs from 5523 AWS to 5520 AMS online with
5529 APC

Procedure 7-3 provides the steps to migrate NEs from the 5523 AWS platform to the
5520 AMS platform while online with the 5529 APC. The NEs are added to the
5529 APC in real time. The 5529 APC configurations prior to the NE migration are
maintained and the 5520 AMS database maintains all records.
Note 1 — Alcatel-Lucent recommends that you perform this
procedure when the activity of the 5529 APC server is low, for
example, at midnight, as there is high resource consumption on the
server for this activity.
Note 2 — The 5523 AWS EML provider and 5529 APC cannot be
synchronized during migration. Also, new NEs cannot be added to the
5529 APC for the 5523 AWS EML provider during migration.

Procedure 7-3 To migrate NEs from 5523 AWS to 5520 AMS online
with 5529 APC
1 Choose Administration→System settings from the 5529 APC main menu. The
System settings window opens.

2 In the Synchronization panel, configure the AWS migration mode enabled


parameter as True.

3 Click on the Apply changes button to save the changes.

4 Synchronize the 5523 AWS EML provider and the 5529 APC, as described in the
5529 Access Provisioning Center User Guide.

5 Migrate the NEs from the 5523 AWS to the 5520 AMS.

6 Delete the migrated NEs from the 5523 AWS, as described in the 5523 AWS ANEL
User Guide and 5523 AWS Operator Guide.

7-4 June 2014 Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10
Edition 01 3JL-02001-CAAA-RJZZA
Installation and Customization Guide
7 — Migrate NEs from 5523 AWS to 5520 AMS

7 Delete the 5523 AWS EML provider from the 5529 APC, if required, as described in
the 5529 Access Provisioning Center User Guide.

Note — This step can only be performed when there are no NEs left on
the 5523 AWS that are still to be managed by the 5529 APC. You can
leave the 5523 AWS EML provider on the 5529 APC if there are NEs left
that were not migrated and that are still managed by the 5529 APC.
8 Perform step 1 to step 3 to configure the AWS migration mode enabled parameter
as False.

7.5 Migrating NEs from 5520 AMS to 5523 AWS online with
5529 APC

Procedure 7-4 provides the steps to migrate NEs from the 5520 AMS platform back
to the 5523 AWS platform while online with the 5529 APC. The NEs are added to
the 5529 APC after the migration using manual synchronization. The 5529 APC
configurations prior to the NE migration is maintained and the 5520 AMS database
maintains all records.
Note — Alcatel-Lucent recommends that you perform this procedure
when the activity of the 5529 APC server is low, for example, at
midnight, as there is high resource consumption on the server for this
activity.

Procedure 7-4 To migrate NEs from 5520 AMS to 5523 AWS online
with 5529 APC
1 Stop supervision of and delete all of the migrated NEs from the 5520 AMS, as
described in the 5520 AMS User Guide.

2 Choose Administration→System settings from the 5529 APC main menu. The
System settings window opens.

3 In the Synchronization panel, configure the AWS migration mode enabled


parameter as False.

4 Click on the Apply changes button to save the changes.

5 Add and start supervision of all of the migrated NEs in the 5523 AWS, as described
in the 5523 AWS ANEL User Guide.

6 Add the 5523 AWS EML provider to the 5529 APC, if required, as described in the
5529 Access Provisioning Center User Guide.

7 Synchronize the 5523 AWS EML provider and the 5529 APC, as described in the
5529 Access Provisioning Center User Guide. The NEs appear in the Configured
state in the 5529 APC GUI for the 5523 AWS EML provider.

Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10 June 2014 7-5
3JL-02001-CAAA-RJZZA Edition 01
Installation and Customization Guide
7 — Migrate NEs from 5523 AWS to 5520 AMS

7-6 June 2014 Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10
Edition 01 3JL-02001-CAAA-RJZZA
Installation and Customization Guide
Uninstalling the 5529 APC and SPFE

8 — Uninstall the 5529 APC and SPFE

Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10 June 2014


3JL-02001-CAAA-RJZZA Edition 01
Installation and Customization Guide
June 2014 Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10
Edition 01 3JL-02001-CAAA-RJZZA
Installation and Customization Guide
8— Uninstall the 5529 APC and SPFE

8.1 Uninstallation overview 8-2

8.2 Uninstalling a 5529 APC NE support plug-in or SPFE NE support


plug-in 8-2

8.3 Uninstalling an AVG plug-in 8-3

8.4 Uninstalling the 5529 APC server 8-4

8.5 Uninstalling the SPFE 8-4

Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10 June 2014 8-1
3JL-02001-CAAA-RJZZA Edition 01
Installation and Customization Guide
8 — Uninstall the 5529 APC and SPFE

8.1 Uninstallation overview

This chapter describes the uninstallation of the 5529 APC server, NE support
plug-ins, AVG plug-ins, and SPFE. Alcatel-Lucent recommends that you uninstall
the 5529 APC when it is not in use.

Before you proceed


As a general practice, Alcatel-Lucent recommends that you back up the 5520 AMS
database before you uninstall the 5529 APC or a 5529 APC NE support plug-in.
The 5529 APC data is backed up by backing up the 5520 AMS database. For
information about how to back up the 5520 AMS database, see the 5520 AMS
Administrator Guide.

8.2 Uninstalling a 5529 APC NE support plug-in or SPFE NE


support plug-in

5529 APC NE support plug-ins or SPFE NE support plug-ins must be uninstalled


individually from the 5520 AMS application server. In a cluster deployment, you
must uninstall the NE support plug-ins separately from each 5520 AMS application
server.

Caution — Uninstalling an NE support plug-in may interrupt the


ongoing NE service provisioning activities that are managed by that
NE support plug-in, as well as disallow future service provisioning for
the NE type. Uninstalling an NE support plug-in may also interrupt
the ongoing NE service provisioning activities that are managed by
other plug-ins that are installed in the 5529 APC.
Alcatel-Lucent recommends that you uninstall an NE support plug-in
when that NE type does not need to be managed anymore, or the
service provisioning activities are low or not occurring for NEs of the
deleted plug-in; for example, during a maintenance window for the
application.

If you are installing NE support plug-ins separately from an overall 5529 APC
uninstall, you must first make sure that you delete all of the 5529 APC templates that
were created using template types that are only available from the NE support plug-in
that you need to uninstall. See the 5529 Access Provisioning Center User Guide for
information about how to delete templates manually. Only templates that are not
applied to a port can be deleted.

8-2 June 2014 Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10
Edition 01 3JL-02001-CAAA-RJZZA
Installation and Customization Guide
8 — Uninstall the 5529 APC and SPFE

For information about how to uninstall 5529 APC NE support plug-ins or SPFE NE
support plug-ins, see the 5520 AMS Installation and Migration Guide.
Note 1 — You cannot deactivate an NE support plug-in while the
JBoss is initializing. You must deactivate the NE support plug-in
before or after the JBoss has initialized. You can, however, deactivate
the plug-in while the JBoss is not running. Run the ams_server status
command to display the status of the JBoss, as described in the
5520 AMS Installation and Migration Guide.
Note 2 — It can take up to one minute to fully deactivate NE support
plug-in processes.

8.3 Uninstalling an AVG plug-in

AVG plug-ins must be uninstalled individually from the 5520 AMS application
server. In a cluster deployment, you must uninstall the 5529 APC AVG plug-ins
separately from each 5520 AMS application server.
Before you perform Procedure 8-1, you must delete all of the 5529 APC templates
that use the AVG plug-in you need to delete. Only templates that are not applied to
a port can be deleted.
Note 1 — You cannot deactivate an AVG plug-in when the JBoss is
initializing. You must deactivate the plug-in before or after the JBoss
is initialized. You can deactivate the plug-in when the JBoss is not
running. Run the ams_server status command to display the status of
the JBoss, as described in the 5520 AMS Installation and Migration
Guide.
Note 2 — Adding or removing an AVG plug-in affects service
provisioning operations using previously installed AVG plug-ins.
Therefore, Alcatel-Lucent recommends adding or removing AVG
plug-ins during a maintenance window.

Before you proceed, you must be able to log in to the server as amssys.

Procedure 8-1 To uninstall AVG plug-ins


1 Log in to the server as amssys.

2 Stop any plug-ins currently in use by running the AVG plug-in deactivation script:

$AMS_LOCAL_DATA_DIR/ams/local/repository/plugin-apc-avg*/bin/dea
ctivate.sh ↵

3 Delete each AVG plug-in that you need to uninstall from the
/var/opt/ams/local/repository/plugin-apc-avg*/apc-avg*/ directory.

Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10 June 2014 8-3
3JL-02001-CAAA-RJZZA Edition 01
Installation and Customization Guide
8 — Uninstall the 5529 APC and SPFE

4 Reactivate the other AVG plug-ins by running the reactivation script:

$AMS_LOCAL_DATA_DIR/ams/local/repository/plugin-apc-avg*/bin/rea
ctivate.sh ↵

5 In a cluster deployment, repeat steps 1 to 4 on each server in the cluster.

8.4 Uninstalling the 5529 APC server

For information about how to uninstall a 5529 APC, see the 5520 AMS Installation
and Migration Guide. In a cluster deployment, you must uninstall the 5529 APC
server separately from each 5520 AMS application server.
Note — It can take up to ten minutes to fully deactivate 5529 APC
server processes. There is a delay between deactivating the 5529 APC
software plug-in and the ability to delete the 5529 APC data from the
database.

8.5 Uninstalling the SPFE

For information about how to uninstall the SPFE plug-in, see the 5520 AMS
Installation and Migration Guide. See the 5529 Access Provisioning Center Service
Provisioning Front End Guide for information about how to use the SPFE.
Note — The SPFE uninstallation process is not affected by whether
the 5520 AMS server is running or not.

8-4 June 2014 Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10
Edition 01 3JL-02001-CAAA-RJZZA
Installation and Customization Guide
Customizing the 5529 APC

9 — Translate the 5529 APC GUI

Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10 June 2014


3JL-02001-CAAA-RJZZA Edition 01
Installation and Customization Guide
June 2014 Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10
Edition 01 3JL-02001-CAAA-RJZZA
Installation and Customization Guide
9— Translate the 5529 APC GUI

9.1 GUI translation overview 9-2

9.2 Translating the GUI 9-3

Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10 June 2014 9-1
3JL-02001-CAAA-RJZZA Edition 01
Installation and Customization Guide
9 — Translate the 5529 APC GUI

9.1 GUI translation overview

By default, the 5529 APC GUI is in English. The GUI menus and windows, and the
templates, can be translated into another language. The translation is performed on
the 5529 APC server; all accounts are affected. The language options are specified
by ISO 639-2. Alcatel-Lucent recommends that you refer to the material provided by
the ISO for more information.

Note — The 5529 APC online documentation is not translated and is


only available in English.

You can translate the 5529 APC GUI by modifying the property files that are
described in Table 9-1.

Table 9-1 Property files

Property file Description Contained in


GUI menus and windows properties files

apc.properties System-wide properties files 100-apc-default- resources.zip file


apc-core.properties
application-framework.properties
dslam-conf.properties
NI-AUDIT-Logger.properties
snmp.properties
util.properties

license.properties License properties


role.properties User management text strings
security.properties
user-management.properties

html.properties General HTML text strings, such as 300-ni.ear file


button text

NE support plug-in template properties files


apc-g7342.properties 5529 APC NE support plug-in apc-NEtype-release-plugin-service
apc-g7342-spfe.properties template properties for the -x.x-r_n.n.n_n.n.n-build.sar file
7342 ISAM FTTU Table 9-2 describes the variables
apc-g7342-detailedErrorMessage.properties

apc-isam.properties 5529 APC NE support plug-in


apc-isam-spfe.properties template properties for the
7302 ISAM/7330 ISAM FTTN/
apc-isam-detailedErrorMessage.properties 7356 ISAM FTTB/7360 ISAM FX

apc-epon.properties 5529 APC NE support plug-in


apc-epon-spfe.properties template properties for EPON
support on the 7360 ISAM FX
apc-epon-detailedErrorMessage.properties

9-2 June 2014 Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10
Edition 01 3JL-02001-CAAA-RJZZA
Installation and Customization Guide
9 — Translate the 5529 APC GUI

9.2 Translating the GUI

Note 1 — The procedures in this section are not applicable to the


SPFE GUI.
Note 2 — Contact your Alcatel-Lucent technical support
representative for assistance with translation.

Prerequisites
Log in to the 5520 AMS server as amssys; see the 5520 AMS Administrator Guide.

Procedure 9-1 To translate the 5529 APC GUI menus and windows
1 Create a temporary directory; for example, /var/tmp/resources/unzipped.

2 Copy the 100-apc-default-resources.zip file to the temporary directory from the


following location on the 5520 AMS server: $AMS_LOCALDATA_HOME/server/
jboss-jbossrelease.GA/server/amssys/deploy/apc, where jbossrelease is the
release of the JBoss.

The 100-apc-default-resources.zip file contains the .properties files.

3 Unzip the 100-apc-default-resources.zip file to the temporary directory.

4 Create locale-specific .properties files. For each locale-specific .properties file:

i Open the .properties file in a text editor and change the text.

Note — If a placeholder is deleted from the .properties file, the


English value is used on the GUI.

ii If a locale-specific .properties file contains non-ASCII characters, note the


type of encoding that is used for each file; for example, utf-8.

iii Save the .properties files.

Note — Keep the default .properties file that corresponds to each


locale-specific .properties file; do not overwrite the default .properties
files.

iv Verify that the privileges of the locale-specific .properties file match the
privileges of the default .properties file.

Note — The default for the locale parameter for new user accounts on
the 5529 APC GUI is set to the language used in the
100-apc-custom-resources.zip file.

Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10 June 2014 9-3
3JL-02001-CAAA-RJZZA Edition 01
Installation and Customization Guide
9 — Translate the 5529 APC GUI

5 If a locale-specific .properties file contains non-ASCII characters, convert the file


to an ASCII file.

i Create a directory to store the converted locale-specific .properties files; for


example, /var/tmp/resources/dist.

ii Navigate to the directory that contains the locale-specific .properties files


that you created in step 4:

cd directory ↵

where directory is the directory path; for example, /var/tmp/resources/unzipped

iii Convert each locale-specific .properties files to ASCII, using the following
command:

$AMS_SOFTWARE_HOME/server/path/native2ascii - encoding
encoding $file directory$file; done ↵

where
path is jdk/bin or jdk-all/x86/bin
encoding is the encoding type that you noted in step 4ii; for example, utf-8
directory is the directory that you created in step i
file is the filename of the locale-specific .properties file

6 Zip the files.

a When you did not perform step 5 (no conversion from non-ASCII to ASCII), zip
all of the updated locale-specific and default .properties files into a file
named 100-apc-custom-resources.zip.

b When you performed step 5 (conversion from non-ASCII to ASCII), zip only the
converted files into a file named 100-apc-custom-resources.zip

7 Copy the .zip files to the $AMS_LOCALDATA_HOME/


server/jboss-jbossrelease.GA/server/amssys/deploy/apc directory on the
5520 AMS server, where jbossrelease is the release of the JBoss.

a When you did not perform step 5 (no conversion from non-ASCII to ASCII),
copy the 100-apc-custom-resources.zip file.

b When you performed step 5 (conversion from non-ASCII to ASCII), copy the
100-apc-custom-resources.zip file and the 100-apc-default-resources.zip
file.

8 Translate the html.properties file; see Procedure 9-2.

9 Restart the 5520 AMS:

./ams_server restart ↵

9-4 June 2014 Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10
Edition 01 3JL-02001-CAAA-RJZZA
Installation and Customization Guide
9 — Translate the 5529 APC GUI

Procedure 9-2 To translate the html.properties file


1 Create a temporary directory; for example, /var/tmp/resources/unzipped/300.

2 Copy the 300-ni.ear to the temporary directory from the following location on the
5520 AMS server:
$AMS_LOCALDATA_HOME/server/jboss-jbossrelease.GA/server/amssys/deploy/a
pc, where jbossrelease is the release of the JBoss

3 Unpackage the 300-ni.ear file in the temporary directory to reveal the kff.jar file:

jar xvf 300-ni.ear ↵

4 Delete the 300-ni.ear file.

5 Create another temporary directory; for example,


/var/tmp/resources/unzipped/kff.

6 Copy the kff.jar file to the new temporary directory.

7 Unpackage the kff.jar file in the temporary directory to reveal the


html.properties file:

jar xvf kff.jar ↵

8 Delete the kff.jar file.

9 Open the html.properties file in a text editor and change the text. For example,
change:

startday=Good morning {0}

to

startday=Hi {0}

The placeholders (for example, {0} or {2,date,long}) are for variable information
that come from the software, such as dates or user names. Move a placeholder to
the desired location in the string, but do not alter the content of the placeholder.
For example, in the placeholder {2,date,long}, the terms “date” and “long” must
not be translated because the terms are used by the 5529 APC to format the date.
The terms are not strings that are directly displayed in the GUI. See
http://java.sun.com/javase/6/docs/api/java/text/MessageFormat.html for
more information.

10 If the html.properties file contains non-ASCII characters, note the type of


encoding that is used for each file; for example, utf-8.

11 Save the locale-specific html.properties file under another name; for example,
ch_html.properties.

12 Verify that the privileges of the locale-specific .properties file match the
privileges of the default .properties file.

Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10 June 2014 9-5
3JL-02001-CAAA-RJZZA Edition 01
Installation and Customization Guide
9 — Translate the 5529 APC GUI

13 If the locale-specific html.properties file contains non-ASCII characters, convert


the file to an ASCII file.

i Navigate to the directory that you created in step 6:

cd directory ↵

where directory is the directory path; for example, /var/tmp/resources/unzipped/kff

ii Convert the locale-specific html.properties file to ASCII, using the following


command:

$AMS_SOFTWARE_HOME/server/path/native2ascii - encoding
encoding $file directory$file; done ↵

where
path is jdk/bin or jdk-all/x86/bin
encoding is the encoding type that you noted in step 4ii in Procedure 9-1; for example, utf-8
directory is the directory for storing converted files that you created in Procedure 9-1
file is the filename of the locale-specific html.properties file

14 Navigate to the directory that you created in step 6 and package the
locale-specific html.properties file and the default html.properties file in the
kff.jar file:

jar cvf kff.jar * ↵

15 Copy the new kff.jar file to the directory that you created in step 1.

16 Navigate to the directory that you created in step 1 and package the updated
kff.jar file in the 300-ni.ear file:

jar cvf 300-ni.ear * ↵

17 Copy the 300-ni.ear file to the $AMS_LOCALDATA_HOME/server/


jboss-jbossrelease.GA/server/amssys/deploy/apc directory on the 5520 AMS
server, where jbossrelease is the release of the JBoss.

Procedure 9-3 To translate the NE support plug-in templates


1 Log in to the 5520 AMS server as amssys.

2 Create a temporary directory.

3 Copy the apc-NEtype-release-plugin-service-x.x-r_n.n.n_n.n.n-build.sar file to


the temporary directory from the following location on the 5520 AMS server:
$AMS_LOCALDATA_DIR/ams/local/repository/plugin-apc-NEtype-x.x-r_n.n.n_n.n
.n-build/apc-NEtype-x.x-y.y_n.n.n_n.n.n-build.

Table 9-2 describes the filename and directory variables.

9-6 June 2014 Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10
Edition 01 3JL-02001-CAAA-RJZZA
Installation and Customization Guide
9 — Translate the 5529 APC GUI

Table 9-2 NE support plug-in template .sar filename and directory variables

Variable Description

Filename variables

NEtype 5529 APC NE support plug-in type. The options are:


• 7342
• isam
• epon

release 5529 APC NE support plug-in release number; for example, 47

x.x 5529 APC NE support plug-in release number; for example, 4.7

r 5529 APC NE support plug-in version number; for example, 1

n.n.n_n.n.n 5520 AMS and 5529 APC release numbers; for example, 9.3.10_9.3.10

build 5529 APC build number; for example, 157898

Directory variables
NEtype 5529 APC NE support plug-in type. The options are:
• 7342
• isam
• epon

version 5529 APC NE support plug-in version; for example, 47

x.x 5529 APC NE support plug-in release number; for example, 4.7

y.y 5529 APC NE support plug-in version number; for example, 1.0

n.n.n_n.n.n 5520 AMS and 5529 APC release numbers; for example, 9.3.10_9.3.10

build 5529 APC build number; for example, 157898

The .sar file contains the .properties files.

4 Unzip the .sar file to the temporary directory.

5 Create locale-specific .properties files. For each locale-specific .properties file:

i Open the .properties file in a text editor and change the text.

Note — If a placeholder is deleted from the .properties file, the


English value is used on the GUI.

ii If the .properties file contains non-ASCII characters, note the type of


encoding that is used for each file; for example, utf-8.

iii Save the updated .properties file with a filename in the format
apc_NEtype_locale.properties. Table 9-3 describes the filename variables.

Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10 June 2014 9-7
3JL-02001-CAAA-RJZZA Edition 01
Installation and Customization Guide
9 — Translate the 5529 APC GUI

Table 9-3 NE support plug-in template .properties filename variables

Variable Description

NEtype 5529 APC NE support plug-in type. The options are:


• 7342
• isam
• epon

locale Language identifier and country code, as specified by ISO 639-1 and ISO 3166-1, and
joined by an underscore; for example, apc-g7342_fr_BE.properties

Note — Keep the default .properties file that corresponds to each


locale-specific .properties file; do not overwrite the default .properties
files.

iv Verify that the privileges of the locale-specific .properties file match the
privileges of the default .properties file.

6 If the locale-specific .properties file contains non-ASCII characters, convert the


file to an ASCII file.

i Navigate to the directory that contains the file that you created in step 5:

cd directory ↵

where directory is the path of the temporary directory you created in step 2

ii Convert the locale-specific .properties file to ASCII, using the following


command:

$AMS_SOFTWARE_HOME/server/path/native2ascii - encoding
encoding $file directory$file; done ↵

where
path is jdk/bin or jdk-all/x86/bin
encoding is the encoding type that you noted in step 5ii; for example, utf-8
directory is the directory that you created in step 2
file is the filename of the locale-specific .properties file

7 Zip the updated locale-specific and default .properties files into a file named
plugin-apc-NEtype-release-plugin-service-release-build.sar.

Table 9-2 describes the filename variables.

8 Copy the .sar file to the directory in step 3.

9 Configure the Default user locale parameter in the System settings window to the
same language as the translated files; see the 5529 Access Provisioning Center
User Guide for information about configuring the Default user locale parameter.

10 Deactivate and reactivate the plugin-apc-NEtype-x.x-r_n.n.n_n.n.n-build plug-in;


see the 5520 AMS Installation and Migration Guide.

When the 5529 APC server is in a cluster installation, you must deactivate and
reactivate the plugin-apc-NEtype-x.x-r_n.n.n_n.n.n-build plug-in on each server
in the 5520 AMS cluster.

9-8 June 2014 Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10
Edition 01 3JL-02001-CAAA-RJZZA
Installation and Customization Guide
9 — Translate the 5529 APC GUI

Table 9-2 describes the filename variables.

Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10 June 2014 9-9
3JL-02001-CAAA-RJZZA Edition 01
Installation and Customization Guide
9 — Translate the 5529 APC GUI

9-10 June 2014 Alcatel-Lucent 5529 Access Provisioning Center, Release 9.3.10
Edition 01 3JL-02001-CAAA-RJZZA
Installation and Customization Guide
Customer documentation and product support

Customer documentation
http://www.alcatel-lucent.com/myaccess
Product manuals and documentation updates are available at
alcatel-lucent.com. If you are a new user and require access to this
service, please contact your Alcatel-Lucent sales representative.

Technical Support
http://support.alcatel-lucent.com

Documentation feedback
[email protected]
© 2014 Alcatel-Lucent. All rights reserved.
3JL-02001-CAAA-RJZZA Edition 01

You might also like