You are on page 1of 28

Service Template Management

Agenda

1. Introduction
2. XMLAPI Script Format
3. Managing Service Templates
4. Categories
5. Creating Service Templates
6. Service Template Examples

All Rights Reserved Alcatel-Lucent 2006, #####

Introduction

All Rights Reserved Alcatel-Lucent 2006, #####

Service Templates - Introduction


The 5620 SAM supports the configuration of VLL, VPLS, IES, VLAN, mirror, and VPRN services
using XML API script-based templates.
The templates allow users to define common characteristics for a service or templatable service
object, and the parameter values that can be configured.
You can create XML API configuration templates for services and child objects of services, and
include sites, access interfaces, SDP bindings, group interfaces, SAPs, and other service-related
objects.
The 5620 SAM generates an XML API script with Velocity properties which you must modify to
generate a UI for the configuration form that is tailored to your requirements and to NE-specific
properties and attributes.

All Rights Reserved Alcatel-Lucent 2006, #####

XMLAPI Script Template Format

All Rights Reserved Alcatel-Lucent 2006, #####

XML API template format


Consider the following when you create an XML API configuration template script:
the generic.GenericObject.configureChildInstance method is the only method that you can
use in XML request
you must configure only the deployer, distinguishedName, and childConfigInfo parameters of
the generic.GenericObject.configureChildInstance method. All other parameters are ignored,
such as synchronousDeploy, deployRetries and clearOnDeployFailure, and must not be
specified.
you must set the deployer parameter to immediate
you must set the value of the distinguishedName parameter to the fully distinguished name of
the parent object
use the getObjectFullName() method with the $parent Velocity variable to retrieve the fully
distinguished name of the parent object. The Velocity variable $parent is set by the system and
can be used in the script whenever the parent context is required
you must add the value of the childConfigInfo parameter for templatable classes only, such as
services, sites, or access interfaces
All Rights Reserved Alcatel-Lucent 2006, #####

XML API template Format


#############################
## Description:
##
#############################

Header

#*
<velocityProperties>
Velocity GUI Properties
</velocityProperties>
*#

Note The velocityProperties tag must be


contained within comments.
#*

*#

<xmlapiRequest xmlns="xmlapi_1.0">
XMLAPI commands
</xmlapiRequest>

Note Only method allowed


generic.GenericObject.configureChildInstance
All Rights Reserved Alcatel-Lucent 2006, #####

Managing Service Templates

All Rights Reserved Alcatel-Lucent 2006, #####

Managing Service Templates


Open the Manage Service Templates window with the command Manage ->
Service Templates. Configure any required filters and then select Search to list
the existing service templates
The Manage Service Templates window is shown below:

All Rights Reserved Alcatel-Lucent 2006, #####

Categories

All Rights Reserved Alcatel-Lucent 2006, #####

Categories
The following service categories can be created by Service Templates:
Class Name

Description

apipe.Apipe

VLL Apipe Service

cpipe.Cpipe

VLL Cpipe Service

fpipe.Fpipe

VLL Fpipe Service

epipe.Epipe

VLL Epipe Service

ipipe.Ipipe

VLL Epipe Service

ies.Ies

IES Service

mirror.Mirror

Mirror Service

mvpls.Mvpls

MVPLS Service

vlan.Vlan

VLAN Service

Vpls.Vpls

VPLS Service

Vprn.Vprn

VPRN Service

All Rights Reserved Alcatel-Lucent 2006, #####

Creating Service Templates

All Rights Reserved Alcatel-Lucent 2006, #####

Creating Service Templates


There are four ways to create a Service Template:
1.

Convert a 5.0 template to a Service Template.

2.

Create a Service Template from an existing Service.

3.

Create a Service Template from the generated first base version.

4.

Create a Service Template from a XMLAPI script.

In addition, Service Templates can be self contained, or can bind child templates
to create hierarchical objects.
Self-contained templates must contain all of the XMLAPI code to generate the
required objects I.e. Service, Site and Sap etc
Services created from templates with bound child templates can select the child
templates from the components tab.

All Rights Reserved Alcatel-Lucent 2006, #####

Convert a 5.0 template to a Service Template


Choose ManageService Templates from the 5620 SAM main menu.
Click on the Old Templates button and choose one of the following:

Browse/Convert Old Service Templates to convert existing service templates


and child objects to XML API service templates

Browse/Convert Old Mirror Service Templates to convert existing mirror service


templates and child objects to XML API service templates

The Browse/Convert Old Service Templates form opens with the Service Template(Service
Management) icon selected.
Click on the Search button. A list of service templates appear.
Select a service template and click on the Convert to XML API Template
button. The selected template will be converted to XML API based service
template. After a successful conversion, the Service_type Service Template
(Edit) form opens with the General tab displayed.
All Rights Reserved Alcatel-Lucent 2006, #####

Creating a Template from an Existing Service

Open the Manage -> Services window and select the service to use as a template.
Select Properties, and the service configuration window will appear.
Select the Create Template button and the Service Template,null[create] window will
appear.

Edit the Name, Description, and Type and the set the Containment options to either
include or exclude all contained objects.

All Rights Reserved Alcatel-Lucent 2006, #####

Creating a Template from an Existing Service

Check the Create Velocity Properties box if a velocity GUI is required.


Select Apply and press Ok if prompted,

and the Service Template configuration window will appear.


Select the Versions tab to then edit version 1
properties to modify the template in the Script
Editor

All Rights Reserved Alcatel-Lucent 2006, #####

All Rights Reserved Alcatel-Lucent 2006, #####

Create a Service Template from the Generated First (Base) version

From the Manage Service Templates window, select the Create button
and the Service Template,null[create] window will appear. Fill in the Name,
Description, Type and State attributes, and then select the Templated Object
Categories and the Templated Object Class Name. Ensure that that the Generate First
(Base) Version box is checked. Select Apply and press Ok if prompted,

and the Service Template configuration window will appear.


Select the Versions tab to then edit version 1 properties to modify the template in
the Script Editor

All Rights Reserved Alcatel-Lucent 2006, #####

Create a Service Template from a XMLAPI script

From the Manage Service Templates window, select the Create button
and the Service Termplate,null[create] window will appear. Fill in the Name,
Description, Type and State attributes, and then select the Templated Object
Categories and the Templated Object Class Name. Ensure that that the Generate First
(Base) Version box is un-checked. Select Apply and press Ok if prompted,

and the Service Template configuration window will appear.


Select the Versions tab to then select the Add button to open the Script Editor
Use the Script Editor and GUI builder to generate the XMLAPI script

All Rights Reserved Alcatel-Lucent 2006, #####

All Rights Reserved Alcatel-Lucent 2006, #####

Service Template with Bound Child Template


The following example will create a VPLS service template with a bound VPLS site
child template:
Create a new Service Template
Select Apply

All Rights Reserved Alcatel-Lucent 2006, #####

Service Template with Bound Child Template


Select the Components tab and select the Create Child Template option

Create a service template for a VPLS site

Select Ok to create and bind the VPLS


site template to the VPLS service
template

All Rights Reserved Alcatel-Lucent 2006, #####

Service Template with Bound Child Template


To create a service from the template, select the Create -> Service from
Template menu

Select the required template from the window that appears, and select Ok

All Rights Reserved Alcatel-Lucent 2006, #####

Service Template with Bound Child Template


Enter the required details configuration window that appears and press Ok.

Checking the Show Created Object box will bring up the configuration window for
the newly created service.
Any bound child templates can be accessed via the components tab.

All Rights Reserved Alcatel-Lucent 2006, #####

All Rights Reserved Alcatel-Lucent 2006, #####

Service Template Examples

All Rights Reserved Alcatel-Lucent 2006, #####

Service Template Examples


From SAM 6.0 onwards, sample XMLAPI templates can be found in the
/opt/5620sam/server/nms/sample/serviceTemplate directory on the SAM
server
Script

Description

createEpipeFromServiceTemplate.txt This example script shows a service template GUI that will:
- create a Epipe service with 2 sites (A and B) and one SAP on each site.
createIesFromServiceTemplate.txt

This example script shows a service template GUI that will:


- create a IES service with one SAP.

createVplsFromServiceTemplate.txt

This example script shows a service template GUI that will:


- create a VPLS service with 2 or 3 sites (A, B and C) and one SAP on each site.
- Site C will be ignored if it is not defined.
This example script shows a service template GUI that will:
- create a VPRN service with 1,2 or 3 sites (A, B and C) and one SAP on each site.
- A site will be ignored if it is not defined.

createVprnFromServiceTemplate.txt

All Rights Reserved Alcatel-Lucent 2006, #####

www.alcatel-lucent.com
www.alcatel-lucent.com

All Rights Reserved Alcatel-Lucent 2006, #####