Cps Hand PDF

Engineering Bulletin
XMC20 CPS Handling Proce-

dures
XMC20
XMC20
XMC20 CPS Handling Procedures Engineering Bulletin
Copyright and Confidentiality Copyright in this document vests in KEYMILE. This document contains confi-
dential information which is the property of KEYMILE. It must be held in con-
fidence by the recipient and may not be used for any purposes except those
specifically authorised by contract or otherwise in writing by KEYMILE. This
document may not be copied in whole or in part, or any of its contents dis-
closed by the recipient to any third party, without the prior written agreement
of KEYMILE.
Disclaimer KEYMILE has taken reasonable care in compiling this document, however
KEYMILE accepts no liability whatsoever for any error or omission in the
information contained herein and gives no other warranty or undertaking as
to its accuracy.
KEYMILE reserves the right to amend this document at any time without
prior notice.
Document PEC EN/LZTBU 882 129/1 RC
Document release XMC20 R4/R6 | 11 December 2015
Confidentiality level Unrestricted
Published by KEYMILE
http://www.keymile.com
Engineering Bulletin
XMC20 CPS Handling Procedures
Content
1 Purpose and Scope 4

1.1 Purpose of this Engineering Bulletin 4
1.2 Intention of a CPS 4
1.3 CPS Provisioning 5
1.4 CPS Deployment Tracking 6
2 CPS Handling Procedures 7

2.1 Procedure with a new XMC20 Installation 7
2.2 Procedure with an existing XMC20 Installation 8
2.3 CPS Compatibility 10
2.4 How to get a new CPS 11
2.5 How to get an updated CPS 12
2.6 How to import and download a CPS 13
2.7 How to configure a CPS 15
3 Background Information 16
3.1 CPS Types and Revisions 16
3.2 CPS Release Handling 19
3.3 CPS Operation 20
4 Annex 22
4.1 Terms and Abbreviations 22
4.2 References 22
4.3 Document History 23
4.4 Technical Support 23
4.5 Product Training 23
© KEYMILE October 2015 page 3 of 23 EN/LZTBU 882 129/1 RC

Purpose and Scope Engineering Bulletin
1 Purpose and Scope
1.1 Purpose of this Engineering Bulletin
This engineering bulletin describes the intention and handling of a custom

parameter set (CPS) together with XMC20 and ECST.
The engineering bulletin covers the situations when a new CPS is provi-
sioned, or when an updated CPS is required, and specifies the procedures
to be followed to
− order a CPS,
− define a CPS,
− install a CPS, and
− configure a CPS.
1.2 Intention of a CPS
A CPS is a set of pre-provisioned (i.e. not ECST controlled) parameters used

to provide parameter values to the ESW of XMC20 units.
The following unit in XMC20 makes use of a CPS:
− The SIP application with the VOIP1 unit requires a
“VOIP_<name>_Rfistv.cps” CPS.
The CPS parameters may be customer or country specific. The adaptation of
these parameters is the responsibility of KEYMILE.
Each customer can define one or more CPS’s. Together the CPS’s build a
database, which the ECST can access.
The CPS is delivered to the customers as a part of a major XMC20 release
or as a customer-specific service pack.
© KEYMILE December 2015 page 4 of 23 EN/LZTBU 882 129/1 RC

23
1.3 CPS Provisioning
With the first deployment of a VOIP1 unit in an operator’s network, a new

CPS has to be defined and created according to the procedures defined in
section 2.1 Procedure with a new XMC20 Installation (on page 7) of this
engineering bulletin.
Under the following conditions an updated CPS is required or distributed:
1.3.1 ESW Release Update
An ESW release update is initiated by KEYMILE.

When an ESW release update requires a new CPS, KEYMILE delivers to
each customer also an updated version of his specific CPS’s. Together with
the updated ESW release, these CPS’s have to be installed and configured
by the customers according to section 2.2 Procedure with an existing
XMC20 Installation (on page 8) of this engineering bulletin.
The CPS delivery is performed on the CD-ROM together with the new ESW.
For registered customers, the most recent CPS is also available for down-
load from KEYMILE’s Extranet (access via http://www.keymile.com). After
the login to the Extranet follow the path
− «Documentation & Software – XMC20 – Software – Custom Parame-
ter Sets».
1.3.2 CPS Parameter Update
A CPS parameter update is initiated by the customer.

A CPS parameter update may be necessary, e.g.
− when operating with a different type of Local Exchange or Softswitch,
− when the functionality of the Local Exchange or Softswitch changes,
− when new ringing signals have been defined,
− when the national PSTN-mapping changes, or
− when an interoperability problem has to be fixed.
The customer notifies KEYMILE if a new CPS is required. KEYMILE creates
the updated CPS and delivers it to the customer. This CPS has to be
installed and configured by the customer according to section 2.2 Procedure
with an existing XMC20 Installation (on page 8) of this engineering bulletin.

23
1.4 CPS Deployment Tracking
The tracking of the CPS deployment status in an operator’s network is a task

of the operator, i.e. the operator must know which CPS release is deployed
in which network element, together with the corresponding unit ESW
releases.

23
CPS Handling Procedures Engineering Bulletin
2 CPS Handling Procedures
2.1 Procedure with a new XMC20 Installation
With a new XMC20 installation using a VOIP1 unit, the following procedure
has to be followed:
new XMC20 installation
interop yes
request the detailed questionnaire from
test OK ?
the KEYMILE customer support
no
fill in the questionnaire and send it back to send the parameter change request to the
the KEYMILE customer support KEYMILE customer support
KEYMILE customer support creates the KEYMILE customer support creates an

requested CPS file and sends it to the updated CPS file and sends it to the pro-
project leader or directly to the customer ject leader or directly to the customer
import the CPS file with the CPS tool of

ECST into the management system
download the CPS file with the CPS tool KEYMILE customer support releases the
of ECST to the network element (NE) final CPS
select the CPS in the unit „Configuration“ with any new ESW release KEYMILE
access point , apply and save the customer support will create an updated
configuration version of the CPS and send it to the
customer
if required restart the unit
perform an interop test
Figure 1: New installation procedure
Certain CPS parameters require a restart of the unit in order that a modifica-
tion becomes applied and operational. These parameters are marked with a
“#” prefix in the parameter description. Select a CPS and click the “View...”
button to display the CPS content.

23
2.2 Procedure with an existing XMC20 Installation
With an existing XMC20 installation using a VOIP1 unit, the following ESW
and CPS upgrade procedures have to be followed.
KEYMILE recommends the use of the newest ESW and CPS in all installa-
tions since this eliminates bugs and deficiencies of legacy ESW and CPS.
existing XMC20 installation
KEYMILE distributes software on the

extranet or on the ESW CD-ROM
No new ESW included . New ESW included . No new ESW included . New ESW included .
No new CPS included . No new CPS included . New CPS included . New CPS included .
import the new ESW file with the ESW import the CPS file with the CPS tool of
the XMC20 configuration is not changed. import the CPS file with the CPS tool of
package manager of ECST into the man- ECST into the management system
Unit services are not interrupted. ECST into the management system
agement system
download the ESW file to the correspon - download the CPS file with the CPS tool download the CPS file with the CPS tool
ding unit of ECST to the network element (NE) of ECST to the network element (NE)
select the new ESW in the unit „Main“ select the CPS in the unit „Configuration“ select the CPS in the unit „Configuration“
access point , apply and save the access point and apply and save the
access point and apply the configuration
configuration and start the unit configuration
the unit will reboot with the new ESW . the unit applies the new CPS .
Unit services are interrupted if required restart the unit Unit services are not interrupted
the unit applies the new CPS . import the new ESW file with the ESW
Unit services are interrupted only if the package manager of ECST into the man-
unit has been restarted agement system
download the ESW file to the correspon -

ding unit
select the new ESW in the unit „Main“

access point , apply and save the
configuration and start the unit
the unit will reboot with the new ESW .

Unit services are interrupted
Figure 2: Existing installation procedure
“#” prefix in the parameter description. Select a CPS and click the “View...”
button to display the CPS content.

23
Note that the imported CPS files are stored on the ECST element manager
in the directory
C:\Users\<user_name>\AppData\Local\CST\filesystembackend\
cps\CustomParameterSet\v_1.00.01.
Please note:
The access path on your machine may not be exactly the same as shown
above.
An updated ECST release will access the same CPS files as the previous
ECST release.

23
2.3 CPS Compatibility
In XMC20 the CPS has to be compatible with the unit ESW release.
Please note:
For compatible combinations of ESW and CPS releases please refer to [012]
Release Note “XMC20”
In general each new ESW release requires also a new CPS release.
Using an old CPS with a new ESW is possible:
• The alarm “Incomplete CPS Version” is set.
• For missing parameters the default value of the ESW is used.
• Parameters that are no longer used are ignored.
Using a new CPS with an old ESW is possible:
• The ESW will ignore the parameters of the extended CPS structure.

23
2.4 How to get a new CPS
If you need a CPS other than the default CPS you first have to fill in a ques-
tionnaire. The questionnaires for the different XMC20 applications can be
ordered at the KEYMILE technical support:
Please refer to the KEYMILE Extranet (via http://www.keymile.com) for sup-
port contact information.
Normally the questionnaires are filled in in close cooperation with the KEY-
MILE technical support. Finally the filled in questionnaire has to be returned
to the KEYMILE technical support who then will create the requested CPS.
The CPS creation requires in maximum 2 weeks.
The new CPS is delivered to the project leader or directly to the customer.

23
2.5 How to get an updated CPS
In some cases, it may be necessary to change the CPS (refer to section

1.3.2 CPS Parameter Update (on page 5)). Please notify KEYMILE or your
supplier if a new CPS is required. KEYMILE may send you a new CPS ques-
tionnaire.
After receiving the filled in questionnaire, KEYMILE will return a modified
CPS. The customer has to install the new CPS file and verify that it behaves
as expected together with the Local Exchange or Softswitch.
The CPS creation requires in maximum 2 weeks.
Please note:
CPS files can not be modified or renamed by a customer. Any change of a
CPS must be performed by KEYMILE.

23
2.6 How to import and download a CPS
Unless not already installed, you must first install your ECST element man-
ager before you can install any CPS file.
The CPS files received from KEYMILE have to be imported to the manage-
ment system and downloaded to the network element with the CPS tool of
ECST:
Figure 3: CPS tool of ECST
To import a CPS file from the file system to the management system press
the button.
The left part of the CPS tool displays all imported CPS files, i.e. CPS files
that are available on the management system.
Please note:
With the import of the first CPS file the ECST automatically creates the CPS
directory in the element manager (the access path on your machine may not
be exactly the same as shown below):
→ C:\Users\<user_name>\AppData\Local\CST\filesystembackend\
cps\CustomParameterSet\1.00.01
→ The CPS files of all applications are stored in the same directory.
→ Do not copy or delete any CPS files manually to or from the CPS
directory.
Selected CPS files are downloaded from the management system to the
network element with the button. To select a CPS file click on the corre-
sponding CPS name. To unselect a CPS file click on the corresponding CPS
name while pressing the “CTRL” button on your keyboard.
The right part of the CPS tool displays all CPS files available on the network
element, i.e. CPS files that have been downloaded. Only CPS files available
on the network element can be selected in the unit configuration.

23
For more information on the CPS tool handling, refer to [355] User Manual
“ECST”.

23
2.7 How to configure a CPS
To make use of a CPS, it must be configured in the ECST and the configura-
tion must be applied to the XMC20 network element.
The VOIP1 CPS configuration is done on the access point AP: /unit-x, Con-
figuration, on the “CPS” tab:
Figure 4: CPS configuration
Applying the configuration with a changed CPS does not interrupt the
XMC20 services.
Please note:
“#” prefix in the parameter description.
→ The restart of a unit interrupts the XMC20 services.

23
Background Information Engineering Bulletin
3 Background Information
3.1 CPS Types and Revisions
3.1.1 Introduction
The following means exist in XMC20 to provide parameter values to ESW,

starting from no flexibility to full flexibility:
1) Hard coded:
Parameters defined at ESW compile time. The parameters have the
same values for all customers.
2) Custom Parameter Set (CPS):

Global set of parameters, pre-provisioned and released. Typically one
set per customer network.
3) Profile:
Global set of parameters, provisioned. Multiple profiles can be edited
in the GUI or CLI and re-used in configurations.
4) GUI:
Individual provisional parameters.
A Custom Parameter Set is a set of pre-provisioned (i.e. not GUI-controlled)
parameters that define an environment-specific behaviour of XMC20 units.
The environment is the sum of the operator’s service requirements, the
applicable telecommunication standards, the type and release of the inter-
working equipment as well as the type and release of the XMC20 units:
− the parameter value is the same for the whole customer network
− the parameter is difficult to be understood by the network operator
− the parameter is global per unit
The advantages of this approach are:
− simplifies the GUI.
− parameters are pre-provisioned rather than hard coded, resulting in
higher flexibility (customization), e.g. to solve interoperability prob-
lems.
− the number of combinations of parameter settings is limited and under
control of KEYMILE and the customer.
3.1.2 CPS Naming Convention
The name of a CPS typically consists of prefix, name, revision and exten-
sion:

23
prefix_name_revision.extension
The prefix is used to distinguish the different types of custom parameter set
files:
Table 1: CPS prefixes

Prefix Unit Application Parameters
VOIP_ VOIP1 VoIP SIP - PSTN national mappings,
- parameters for the SIP and RTP protocol
implementation,
- traffic related parameters (codec, tone,
ringing signal parameters etc.)
- call progress tones
The name contains a subset of the following parameters:
− country
− operator
− switch or softswitch manufacturer
− switch or softswitch type
− software load
The revision has a format as described in the paragraph below.
The extension of the CPS file for XMC20 is .cps.
3.1.3 CPS Revision Format
The CPS revision format is structured as follows:

Format = Rfistv
Example: R1A001
where
• R = constant for “Revision“
• f = function version:
One digit 1 to 9. A different function version stands for a functionality
change, i.e. an extension of the CPS data structure.
It is not linked to the ESW implementation version.
• i = implementation version:
One capital letter A to Z except I O P Q R U W. A different implementa-
tion version stands for a bug-fix or a parameter modification.
The implementation version is incremented whenever a CPS gets modi-
fied after it has been released to a customer for field deployment (not for
interoperability testing).
It is not linked to the ESW implementation version.
• s = CPS structure:
One character 0 to 9, then a to z. Minor structure change, adding of CPS
parameters.
• t = CPS template file version:
One character 0 to 9, then a to z. E.g. text changes done in the common
CPS template file.
• v = CPS value file version:
One character 0 to 9, then a to z. Change of parameter values in the indi-
vidual CPS value file.

23
CPS structure, template file and value file versions are for KEYMILE internal
use only.

23
3.2 CPS Release Handling
3.2.1 CPS life cycles
Table 2: CPS life cycle

CPS revision Description
R1A → R1B Parameter value change
↓
R2B New structure of CPS
↓
R3B → R3C New structure of CPS, later any value modifica-
tions
Please note:
If the structure of the CPS changes, i.e. the function version, then the imple-
mentation version remains and does not start with A again (e.g. R2B Þ R3B).
3.2.2 CPS Revisioning Examples
1) A new CPS is created:

→ filename_R1A001.cps
2) CPS parameter values get changed in the development cycle:

filename_R1A001.cps → filename_R1A002.cps
3) CPS parameters get added or removed in the development cycle:

4) CPS detail text gets changed in the development cycle:

5) CPS parameter values get changed after a CPS was released:

filename_R1A112.cps → filename_R1B113.cps
6a) The CPS structure is extended because of added functionality,

existing parameters are NOT modified:
filename_R1B113.cps → filename_R2B001.cps
6b) The CPS structure is extended because of added functionality and

existing parameters get changed:
filename_R1B113.cps → filename_R2C001.cps

23
3.3 CPS Operation
3.3.1 Use Cases
3.3.1.1 Set a CPS
This use case describes the setting of the custom parameters in the XMC20.
The custom parameters are pre-provisioned parameters.
• Pre conditions:
A custom parameter set has to fulfil the following requirements to be visi-
ble to the user:
− The name prefix must be correct
− The CPS file has to be imported into the element manager and down-
loaded to the XMC20 network element.
• Result:
The correct custom parameter set is applied to the configuration.
3.3.1.2 Add an old CPS to a new ESW
This use case describes the situation, when an old CPS (from a former ESW
revision) is used with a new ESW function revision that requires an extended
CPS structure.
• Result:
When an old CPS which is not compatible with the ESW in respect of the
CPS structure (ESW function version newer than the CPS function ver-
sion) is provided to the ESW, the alarm “Incomplete CPS Version” is
set.
For missing parameters the default value of the ESW is applied, i.e. the
unit is working but the behaviour is untested.
Parameters that are in the CPS but no longer used in the ESW are
ignored.
3.3.1.3 Add a new CPS to an old ESW
This use case describes the situation, when a new CPS (with an extended
CPS structure) is used with a former ESW that does not support the
extended structure.
• Result:
It is allowed to apply a new CPS with extended structure (different func-
tion version) to an old ESW revision.
The ESW will ignore the parameters of the extended structure, as they
are not known.
Note that all parameters will be shown in the ECST “Preview…” window,
even though they are not used by the ESW.

23
3.3.2 ECST/UNEM Warning Messages
The following table shows the CPS related error and warning messages of
the ECST/UNEM:
Table 3: ECST/UNEM alarms

Situation CPS related error message
The user updates the unit ESW with a Incomplete CPS Version
newer version (function or implementa- (the configured CPS is not complete or
tion version) outdated, i.e. from a previous release)

23
Annex Engineering Bulletin
4 Annex
4.1 Terms and Abbreviations
Table 4: Terms and abbreviations

Abbreviation Meaning Explanation
AP Access Point Specific point in the ECST GUI
managed objects tree
CPS Custom Parameter Set
EB Engineering Bulletin
ECST XMC20 Enhanced Configura- Network element manager in the
tion Software Tool context of the XMC20 system
release R4/R6
ESW Embedded Software Software that is running on a spe-
cific HW unit of the XMC20
GUI Graphical User Interface
HW Hardware
VOIP1 XMC20 service unit High density SIP gateway unit
4.2 References
Any version(s) and/or release(s) indicated with the below listed document
titles identify the specific state of the software and/or feature set at the crea-
tion time of the present document. If the present document is published as
part of a document collection, the hyperlinks might open a document valid for
a newer version/release. That updated version is valid in the context of all
units and features described in the document collection.
Please note:
For the new HTML-based documentation site there are no interdocument
hyperlinks realized yet.
→ Please find the required document via the navigation tree on the left.
[012] Release Note “XMC20”
[355] User Manual “ECST”

23
Annex Engineering Bulletin
4.3 Document History
Table 5: Document history

KEYMILE PEC Date XMC20 Changes since previous
release
EN/LZTBU 882 129/1 RC November 2015 R6 Minor editorial changes.
Applicable for the XMC20 system releases R4 and R6.
EN/LZTBU 882 129/1 RB July 2015 R6 HW name for VOIP1 corrected
EN/LZTBU 882 129/1 RA March 2015 R6 Release for the XMC20 system release R6.
EN/LZTBU 882 129 RG February 2015 R4 First release of the XMC20 CPS Handling Procedures
Engineering Bulletin for the XMC20 system release R4.
4.4 Technical Support
Please refer to the KEYMILE Extranet (via http://www.keymile.com) for sup-

port contact information.
4.5 Product Training
Training courses are available for a wide range of KEYMILE products and
applications.
For contact information, course descriptions, locations and dates, go to the
Website: http://www.keymile.com, then search for “product training”.

23

Cps Hand PDF

Caricato da

Informazioni sul documento

Titolo originale

Copyright

Formati disponibili

Condividi questo documento

Condividi o incorpora il documento

Opzioni di condivisione

Hai trovato utile questo documento?

Questo contenuto è inappropriato?

Copyright:

Formati disponibili

Cps Hand PDF

Caricato da

Copyright:

Formati disponibili

Engineering Bulletin

XMC20 CPS Handling Proce-

Document PEC EN/LZTBU 882 129/1 RC

Document release XMC20 R4/R6 | 11 December 2015

Confidentiality level Unrestricted

1 Purpose and Scope 4

2 CPS Handling Procedures 7

© KEYMILE October 2015 page 3 of 23 EN/LZTBU 882 129/1 RC

1 Purpose and Scope

1.1 Purpose of this Engineering Bulletin

This engineering bulletin describes the intention and handling of a custom

1.2 Intention of a CPS

A CPS is a set of pre-provisioned (i.e. not ECST controlled) parameters used

© KEYMILE December 2015 page 4 of 23 EN/LZTBU 882 129/1 RC

1.3 CPS Provisioning

With the first deployment of a VOIP1 unit in an operator’s network, a new

1.3.1 ESW Release Update

An ESW release update is initiated by KEYMILE.

1.3.2 CPS Parameter Update

A CPS parameter update is initiated by the customer.

© KEYMILE December 2015 page 5 of 23 EN/LZTBU 882 129/1 RC

1.4 CPS Deployment Tracking

The tracking of the CPS deployment status in an operator’s network is a task

© KEYMILE December 2015 page 6 of 23 EN/LZTBU 882 129/1 RC

2 CPS Handling Procedures

2.1 Procedure with a new XMC20 Installation

new XMC20 installation

KEYMILE customer support creates the KEYMILE customer support creates an

import the CPS file with the CPS tool of

if required restart the unit

perform an interop test

Figure 1: New installation procedure

© KEYMILE December 2015 page 7 of 23 EN/LZTBU 882 129/1 RC

2.2 Procedure with an existing XMC20 Installation

existing XMC20 installation

KEYMILE distributes software on the

download the ESW file to the correspon -

select the new ESW in the unit „Main“

the unit will reboot with the new ESW .

Figure 2: Existing installation procedure

© KEYMILE December 2015 page 8 of 23 EN/LZTBU 882 129/1 RC

© KEYMILE December 2015 page 9 of 23 EN/LZTBU 882 129/1 RC

2.3 CPS Compatibility

© KEYMILE December 2015 page 10 of 23 EN/LZTBU 882 129/1 RC

2.4 How to get a new CPS

© KEYMILE December 2015 page 11 of 23 EN/LZTBU 882 129/1 RC

2.5 How to get an updated CPS

In some cases, it may be necessary to change the CPS (refer to section

© KEYMILE December 2015 page 12 of 23 EN/LZTBU 882 129/1 RC

2.6 How to import and download a CPS

Figure 3: CPS tool of ECST

© KEYMILE December 2015 page 13 of 23 EN/LZTBU 882 129/1 RC

© KEYMILE December 2015 page 14 of 23 EN/LZTBU 882 129/1 RC

2.7 How to configure a CPS

Figure 4: CPS configuration

© KEYMILE December 2015 page 15 of 23 EN/LZTBU 882 129/1 RC

3.1 CPS Types and Revisions

The following means exist in XMC20 to provide parameter values to ESW,

2) Custom Parameter Set (CPS):

3.1.2 CPS Naming Convention

© KEYMILE December 2015 page 16 of 23 EN/LZTBU 882 129/1 RC

Table 1: CPS prefixes

3.1.3 CPS Revision Format