Sigma Provisioning 6.2 Administration and Operation Guide PDF

Sigma Provisioning
Version 6.2
Administration and Operation
Guide
Copyright © 1996‐2018 Sigma Systems Canada LP.
Sigma Systems Canada LP., Toronto, ON, Canada
The Programs, which include both the software and documentation, contain information that is proprietary to
Sigma Systems Canada LP. and its licensors; they are provided under a license agreement containing restrictions
on use and disclosure and are also protected by copyright and other intellectual and industrial property laws.
Except as may be expressly permitted in such license agreement, no part of the Programs may be reproduced or
transmitted in any form or by any means, electronic or mechanical, for any purpose. Reverse engineering,
disassembly, or decompilation of the Programs, except as expressly permitted by law, is prohibited.
The information contained in this document is subject to change without notice. If you find any problems in the
documentation, please report them to us in writing. This document is not warranted to be error‐free.
Sigma product names are trademarks of Sigma Systems Canada LP. and may be registered in certain jurisdictions.
Other names may be trademarks of their respective owners. A complete list of third‐party software and
copyrights is included in the libraries of each binary distribution.
3
Contents
About this Document ................................................................. 9
Purpose and Scope .............................................................................................9
Audience ...............................................................................................................9
For More Information.......................................................................................10
Installing Sigma Provisioning .................................................... 11
Overview ............................................................................................................11
Elastic Clustering Support ................................................................................12
Service‐End‐Point and Routes .........................................................................12
Prerequisites ......................................................................................................14
Prerequisites for Sigma Admin........................................................................14
Prerequisites for Application Hosts.................................................................14
Sigma Provisioning Docker Images ................................................................14
Preparing the Database ...................................................................................16
Uploading the Sigma Provisioning Deployment Specification and Project
Configuration ................................................................................................17
Overview ..........................................................................................................17
Uploading the Deployment Specification and Project Configuration............17
Deploying the Sigma Provisioning Router Containers ................................20
Overview ..........................................................................................................20
Deploying the SMP‐Router Containers ...........................................................20
Installing the Sigma Provisioning Application Nodes .................................24
Installing the Sigma Provisioning Database..................................................32
Installing Sigma Provisioning Admin .............................................................33
Integrating with Sigma Insights ......................................................................35
Overview ..........................................................................................................35
Integrating with Sigma Insights.......................................................................36
Administering Sigma Provisioning............................................. 39
Home Page .........................................................................................................39
Servers..............................................................................................................40
Managed Components ....................................................................................40
Sigma Provisioning 6.2 Administration and Operation Guide
© Sigma Systems | Company Confidential
4
Servers Page.......................................................................................................41
Servers Detail...................................................................................................42
Managed Components....................................................................................... 42
Data Source ....................................................................................................... 43
Node Detail ....................................................................................................... 43
Thread Pool ....................................................................................................... 44
JVM Details........................................................................................................ 45
System Properties.............................................................................................. 46
Components Page .............................................................................................47
Managed and Unmanaged Components ........................................................47
Component Details..........................................................................................48
Destination Runtime Summary .......................................................................... 48
Component Runtime.......................................................................................... 50
Component Configuration.................................................................................. 50
Destination Configurations ................................................................................ 50
Destination Detail Page ...................................................................................52
Destination Runtime Summary .......................................................................... 52
Destination Configurations .............................................................................54
Destination Runtime Details ...........................................................................54
Data Sources ......................................................................................................57
Data Source Runtime ......................................................................................... 57
Data Source Config ............................................................................................ 58
Queues ................................................................................................................59
Destinations .....................................................................................................59
Destination Configurations ................................................................................ 60
Messages..........................................................................................................60
Messages Overview ........................................................................................... 60
Messages Page.................................................................................................61
Message Detail .................................................................................................. 62
Monitor Destination .......................................................................................... 63
Monitor Memory............................................................................................... 64
Monitor Thread Pool.......................................................................................... 64
Service Profile Manager ........................................................... 65
Accessing Service Profile Manager ................................................................66
Logging in to Log in to Service Profile Manager .............................................66
Managing Subscribers ......................................................................................68
Adding New Subscribers ‐ Residential and Business......................................68
Searching for a Subscriber...............................................................................71
Searching for a Large Subscriber.....................................................................73
Viewing a Subscriber's Profile ........................................................................73
Viewing Large Subscriber Services..................................................................74
Changing Subscriber Status.............................................................................75
5
Editing Subscriber Information .......................................................................76
Editing Large Subscriber Information .............................................................77
Managing Orders ..............................................................................................78
Searching for an Order ....................................................................................78
Viewing an Order.............................................................................................81
Creating a Scheduled Order.............................................................................82
Editing Scheduled Order Start Date ................................................................83
Editing Scheduled and Held Order Details......................................................84
Creating and Holding an Order .......................................................................85
Releasing a Held Order for Processing ............................................................86
Scheduling a Currently Held Order .................................................................86
Releasing a Scheduled Order for Processing...................................................87
Canceling Scheduled and Held Orders ............................................................87
Creating Multiple Orders for a Subscriber......................................................88
Capturing Event‐Based Orders ........................................................................88
Processing Pre‐Queued Orders .......................................................................90
Processing Aborted Orders..............................................................................91
Canceling a Failed Order..................................................................................91
Repairing a Failed Order..................................................................................92
Error Messages and Retries.............................................................................93
Managing Batches ............................................................................................93
Creating a Batch...............................................................................................93
Searching for Batches ......................................................................................96
Replicating Orders in a Batch ..........................................................................96
Adding Orders to a Batch ................................................................................98
Managing Services ............................................................................................98
Adding Orderable Services to a Residential Subscriber .................................98
Adding Orderable Services to a Business Subscriber ...................................102
Adding Voice Services....................................................................................103
Adding on Demand or Event‐Based Services................................................105
Submitting an Order from the Shopping Cart ..............................................106
Adding Voice Mail or Feature Packages for a Subscriber.............................108
Swapping a Cable Modem or MTA................................................................108
Suspending and Deleting Services ................................................................ 110
Resetting a Voice Mail Password .................................................................. 111
Searching for Selective Services.................................................................... 111
Loading Selective Services............................................................................. 112
Searching for and Loading Associated Services............................................ 113
Executing Manual Tasks ................................................................................. 114
Running Migrations ........................................................................................ 117
Service To Resource Mapping ....................................................................... 118
6
Adding Service to a Resource Map Definition.............................................. 118
Deleting Service from a Resource Map Definition ....................................... 119
Adding Regional Event Definition ................................................................. 119
Deleting Regional Event Definition ...............................................................120
Using Network Query .....................................................................................120
Defining a New Query Type ..........................................................................121
Accessing Access Control from SPM Web ...................................................121
Fine Grained Authorization...........................................................................121
Authorization Manager (AM)........................................................................122
Concepts.......................................................................................................... 123
Tips.................................................................................................................. 124
Managing Groups ............................................................................................ 125
Managing Resources, Privileges, and Permissions ............................................ 132
Accessing the External Application from SPM Web ..................................144
Sigma Provisioning Topology and STM Configuration ..............145
Service Topology Manager (STM) Web UI ..................................................145
Accessing the STM Web UI ............................................................................145
Searching for Consumable Resources ...........................................................147
Searching for a Network Element .................................................................148
Searching for a Subnetwork Element ...........................................................150
Viewing a Link................................................................................................153
Viewing Technology Platform Details...........................................................154
Service Topology Manager (STM) Projects .................................................156
Navigating the STM Web UI ..........................................................................158
Creating a Network........................................................................................160
Modifying a Network ....................................................................................162
Creating a Link ...............................................................................................164
Assigning a Technology Platform ..................................................................166
Deleting a Link ...............................................................................................168
Deleting a Network........................................................................................169
Archiving and Purging the Database ........................................171
Overview ..........................................................................................................171
Archiving Framework and Reporting ...........................................................172
Archiving and Purging Options .....................................................................173
Utility Processes ............................................................................................173
ARCHIVE Mode ................................................................................................ 173
PURGE Mode ................................................................................................... 174
ARCHIVE‐PURGE Mode .................................................................................... 174
Setting Up arch_purge.properties for the Utility .........................................174
A and P Mode .................................................................................................. 174
7
Archive Group.................................................................................................. 174
Filtering Criteria............................................................................................... 175
Archive Mode .................................................................................................. 175
Archiving and Purging Options Details .........................................................175
A and P Transactional Modes ........................................................................... 175
Archive or Purge Groups .................................................................................. 175
Filter Criteria ................................................................................................... 177
Operation Modes ............................................................................................178
Operation Modes Table .................................................................................178
Operation Modes Table Key ............................................................................. 178
Transaction Modes ........................................................................................178
Guidelines ......................................................................................................179
Configuring the Archive and Purge Environment ......................................179
Prerequisites ..................................................................................................179
Procedure.......................................................................................................180
Environmental Variables ...............................................................................180
Example........................................................................................................... 180
Archive Modes ...............................................................................................181
Example........................................................................................................... 181
Subscriber AP.................................................................................................181
Variables.......................................................................................................... 181
Example........................................................................................................... 181
Sub‐Order AP .................................................................................................182
Variables.......................................................................................................... 182
Example........................................................................................................... 182
JWF AP ...........................................................................................................182
Variables.......................................................................................................... 182
Example........................................................................................................... 182
STATE_LIST and STATUS Options ....................................................................... 183
Sigma Provisioning Licensing ...................................................184
License Control ................................................................................................184
License File .......................................................................................................184
Obtaining a New License ...............................................................................185
Downloading the Sigma Provisioning License File ....................................185
Updating Email Notifications ........................................................................186
Replacing the License File .............................................................................188
Appendix: Authorization Manager Privilege Matrices..............190
AM Privilege Matrix .......................................................................................190
SPM Privilege Matrix ......................................................................................191
Named Queries Privilege Matrix ..................................................................198
8
Manual Task Web Privilege Matrix ..............................................................199
STM Privilege Matrix ......................................................................................199
Management Beans Privilege Matrix ..........................................................200
Workflow Console Privilege Matrix .............................................................200
SCT Privilege Matrix .......................................................................................201
9
About this Document
This document contains information about Sigma Provisioning. This section provides an overview of
the information contained in this document.
Purpose and Scope
This document focuses on Sigma Provisioning Administration and Operations use cases. Once
deployed, Sigma Provisioning has a number of tools and processes that need to be run and
maintained to ensure the effective operation of the product in a production environment. It details
tasks associated with administrative tasks and operations.
Audience
This document is written for anyone who would like technical details about Sigma Provisioning,
including the following audiences:
Audience Implementation Role Use of this guide
Sigma Provisioning Platform • Gather technical requirements Understand the capabilities and
Configuration Developers • Design Workflows generic step-by-step instructions to
configure technology cartridges
• Configure technology
Solutions and delivery engineers and provisionable services, and to
adapters and or services
integrate components
Integration Specialists • Integrate components
• Install Sigma Provisioning
• Participate in user acceptance
testing (UAT)
System Administrators • Operational Maintenance of • Understand the administrative

Sigma Provisioning and maintenance tasks for
• First line support Sigma Provisioning
• Installation of Sigma • Understand basic functionality
Provisioning so as to provide support
• Database Maintenance
Business Owners • Overall responsibility for • Understand the

implementation implementation processes
• Business users of the product • Understand basic functionality
and potential of the product
10
For More Information
Refer to the following guides provided with your Sigma Provisioning product distribution:
• Sigma Provisioning 6.2 Release Notes
• Sigma Provisioning 6.2 Installation Pre-Requisites and Hardware Sizing Guidelines
• Sigma Provisioning 6.2 Product Concepts
• Sigma Provisioning 6.2 Developer and Integrator Guide
You should also consult any other relevant documentation provided by your Sigma Professional
Services team.
11
Installing Sigma Provisioning
• Overview
• Elastic Clustering Support
• Prerequisites
• Sigma Provisioning Docker Images
• Preparing the Database
• Uploading the Sigma Provisioning Deployment Specification and Project Configuration
• Deploying the Sigma Provisioning Router Containers
• Installing the Sigma Provisioning Application Nodes
• Installing the Sigma Provisioning Database
• Installing Sigma Provisioning Admin
• Integrating with Sigma Insights
Overview
Based on the Create, Sell and Deliver strategy, all Sigma Systems products (including Sigma
Provisioning), are deployed and managed through Sigma Admin to provide a unified user experience
across products. The following diagram shows a typical scenario where the Sigma product suite is
managed by Sigma Admin, with a standard four node Sigma Provisioning cluster (that is highlighted).
12
Sigma Provisioning contains the following five components:

• Sigma Provisioning Nodes: Hosts all applications required for service activation.
• Sigma Provisioning Admin: Manages application components, resources, etc.
• Sigma Provisioning Tooling Node: Hosts tools required by the Development and Operations team.
• Sigma Provisioning Routers: Hosts application service end-point routes for elastic clustering.
• Sigma Provisioning fluentd: Used for Sigma Insights Integration.
The application components running inside each Sigma Provisioning node are controlled through the
installation configuration, such as java‐dev.xml, and java‐perf.xml. These components are
included with the build and are typically defined during the development process in collaboration with
deployment teams.
Elastic Clustering Support
Sigma Provisioning now supports elastic clustering. This allows application nodes to be added or
removed from the cluster without first having to stop the application cluster.
Service‐End‐Point and Routes
With elastic clustering, the cluster topology changes over time. To hide these changes from external
actors, Sigma Provisioning uses routers that act as a proxy. A router publishes a set of routes.
These routes each represent an application service-end-point. When an external client connects to
a route for a specific application service, the router forwards the request to one of the active nodes
behind that service end point. Also, since application nodes are either added or removed using Sigma
Admin, the router configurations are updated to reflect the new cluster topology.
For example, the performance cluster deployment for the SMP Demo has two routes for handling web
traffic to applications that are running on the SMP and the JWF nodes (like the SMPWeb UI, the
STMWeb UI, and the Workflow Console applications). These routes are configured to pin the
requests from a web client to an application node, where session stickiness is required.
13
Another dedicated route is setup to the SMP nodes for those applications where proper loadbalancing
is required (like OSS/BSS systems that use Provisioning Order Manager APIs). Implementation
teams can define additional routes to expose APIs for applications like the Workflow Engine or JEAs,
as needed.
In production environments, Sigma Systems recommends deploying two routers for redundancy. The
routers may be deployed as peers fronted by a loadbalancer, or setup as primary/secondary with an
IP failover strategy. The network team on site may choose to implement the routing configuration
based their own organizational guidelines.
Sigma Provisioning testing was done with the following configuration in place:
• Unique DNS aliases for each route on the router host
• Two routers configured as peers, with peer-to-peer synchronization deployed on separate hosts
that provide redundancy
The following diagram shows how the peer-to-peer synchronization between routers pins a web client
to a node to achieve the web session stickiness:
• When the initial login request hits router-2, it is forwarded to the SMP2 node where a web session
is created. Also, the connection information of user to SMP2 information is synced to router-1.
• When the user sends a select web request later:
• If the loadbalancer happens to send it to router-1, it will then forward the web request to SMP2
based on sync information received from router-2 earlier
• If router-2 happens to be down at that time, then the loadbalancer will send it to router-1 which
has the synced information from router-2 to help it forward the web request to SMP2 for user
session continuity
14
Prerequisites
Prerequisites for Sigma Admin
Before installing Sigma Provisioning, ensure the following Sigma components are installed:
• Sigma A&A with Loadbalancer: set the built_in_realm_alias property to samp for Sigma A&A
as needed by Sigma Provisioning
• Sigma Configuration Container
• Sigma Admin
Prerequisites for Application Hosts
For application hosts, ensure the following:
• All application hosts have the correct version of Docker installed and configured.
• A directory exists with the necessary SSL certificates.
• A directory is set up for application logs and adequate disk space exists.
Sigma Provisioning Docker Images
Implementation Docker images are available in the Docker registry. The standard Sigma Provisioning
distribution contains the following Docker images:
• smp-runtime: Contains the proper version of necessary infrastructure software pre-configured
with the binary artifacts for Sigma Provisioning runtime. These Docker containers should be
treated as read-only containers. Users should not make any changes to these containers directly
because subsequent deployment of code fixes and upgrades recreates these containers and the
local changes will be lost.
When deploying the smp-runtime, set the type attribute to control which applications will be
running in that instance. The types are defined as part of development in Sigma Provisioning
installation configuration, such as java‐perf.xml. Standard performance clusters have two
server types:
• jwf-jea: Runs the Workflow Engine and all JEAs.
• smp: Runs the rest of Sigma Provisioning applications.
The runtime container type names are logical names that implementations can choose.
Implementation teams can define other container-types based on deployment needs.
• smp-tooling: This container has all of the Sigma Provisioning tools, such as install db, and
cfgupd SbNotify (among others).
• smp-router: This Docker image contains HAProxy. It is used to set up routes for application
service end-points that are required for elastic clustering.
• smp-gitdata: This image holds the deployment configuration specifications used by the Sigma
Admin and Sigma Provisioning implementation project configurations. This image is used during
deployment to upload spec and project configuration to the configuration‐server.
15
• smp-logging-fluentd: This Docker image contains the fluentd application which is optionally
deployed for Sigma Insights integration.
• Named Volumes: Apart from the Docker images described above, Sigma Provisioning also
requires the following Docker named volumes, which are configured in the deployment specs.
Sigma Admin creates and mounts these volumes to the smp-runtime containers as part of the
deployment process.
• smp-cfg: This acts as a project configuration cache. When the application starts, 
{project}‐cfg is cloned from the configuration-container. Subsequent changes from the
configuration-container are synchronized on restarts, or through the cfgupd tool.
• smp-env: This acts as an environment configuration cache. When the application starts, the
env_user_{profile}.json file is downloaded from Sigma Admin and is kept synchronized
when users change the configuration from the Sigma Admin UI.
• smp-tmp: This is a temporary directory for applications. For example, Jetty uses tmp/
{node_name} for jsp compilation. The JEA framework uses this location to generate dynamic
REST end points (etc).
• smp-data: Logback configuration files are stored here when the application starts. Also,
implementation components like the BSS adapter can use this location to store runtime data.
• smp-log: By default, the application log files go here. If the user decides to mount a host
directory during deployment, then the host directory is used for the named volume mount. The
advantage of using a host mount is that you can view log files directly from the host.
• smp-ssl: The host-mounted directory for the location of the SSL certificate.
16
Preparing the Database
Sigma Provisioning is certified for Oracle CDB with RAC scan-IP. For more information on version
details, refer to the Sigma Provisioning 6.2 Installation Pre-Requisites and Hardware Sizing
Guidelines document.
The DBA must run the following tasks before installing Sigma Provisioning:
1 Create the tablespaces needed by Sigma Provisioning by using 
{SMP_HOME}/db/install/db/create_tablespaces.sql.
2 Set up the necessary context using {SMP_HOME}/db/install/db/ctx_system.sql.
3 Install Oracle JVM on the database server. JVM is installed by default when the database is
created from the Database Configuration Assistant.
Three database schemas are required for Sigma Provisioning deployment:
• {name}CM, {name}AM, and {name}AA
4 Apply all required OS patches and configure the Oracle user and kernel parameters.
5 Configure the Sigma Provisioning Database instance to satisfy minimum requirements.
If this is a production deployment, you must use Oracle RAC and configure the following:
• Oracle RAC Scan IP
• Fast Connection Failover (FCF)
Once the Sigma Provisioning pre-requisites are completed, you can deploy the Sigma Provisioning
deployment specification and project configuration. The first phase of this process is to initialize the
Sigma Provisioning project configuration repositories in the sigma‐configuration‐server (assuming
it was not already done during the Sigma Admin deployment).
17
Uploading the Sigma Provisioning Deployment
Specification and Project Configuration
Overview
Uploading the Deployment Specification and Project Configuration
Perform the followings steps:
1 Log in to Sigma Admin.
Note: Since users have not yet been loaded from Sigma A&A, you may need to log in as the
Sigma Admin super user from https://{sa-host}:{sa-port}/superuser.
2 Click Force Operation to stop the sigma‐configuration‐server.
18
3 Click Edit to edit the sigma‐configuration‐server.
4 When the configuration section appears, enable the INIT_REPOS (if not already enabled), and
then add an INIT_REPO for the Sigma Provisioning project.
5 Enter the project name and create a comma separated list of project-configuration and shelf tech
cartridge repositories to use in the project. The following example shows the SMP Demo
configuration. Enter the details that are specific to your own project.
6 Review the changes, then click Submit.

7 From the Configuration Manager menu, upload the Sigma Provisioning project configuration to
the configuration-container. Using the from image option, enter the Docker image name in the
following format:
{docker‐name‐space}/{git‐data‐docker‐image‐name}:{docker‐image‐version}
Enter the project configuration repository name in the following format:
{project}‐cfg
8 Click Upload to complete the operation.
19
9 Click the Configuration Manager tab and upload the Sigma Provisioning installation specification
to the Sigma Admin registry. Using the from image option, enter the Docker image name in the
following format:
{docker‐name‐space}/{git‐data‐docker‐image‐name}:{docker‐image‐version}
10 Click Upload to complete the operation.

Note: The same process can be used later to upgrade Sigma Provisioning to a never version.
This is done by uploading a new Sigma Provisioning specification.
20
Deploying the Sigma Provisioning Router Containers
Overview
To support elastic clustering, Sigma Provisioning deploys two peer-to-peer smp-router containers,
which are based on HAProxy. Sigma Admin will deploy the routers and notify them when the cluster
topology changes. In turn, the routers will update the number of service end points behind the
impacted route(s)
Deploying the SMP‐Router Containers
After uploading the deployment specification and project configuration to the sigma-configuration
container, deploy the smp-router containers by performing the following steps.
1 From the Deployment Manager tab select the router application under smp.
21
2 Once this is selected, fill in the router configuration data based on the following information:
• router stats port: Used to monitor router traffic statistics
• router-peer-port: Used to sync the connection between peer routers needed for failover and
session stickiness
• router frontend port: Front end port for the router service end point. In production
environments this is typically set to https port, 443.
• smp-api-proxy-host: Front end host name for the SMP API service end point, where the
connection requests are loadbalanced. Typically this is a DNS alias that maps to the host
name
• smp-proxy-host: Front end host name for the SMP web based service end point, where the
connection request is pinned to a node. Typically this is a DNS alias that maps to the host
name
• jwf-proxy-host: Front end host name for the JWF web based service end point, where the
connection request is pinned to a node. Typically this is a DNS alias that maps to the host
name
End User Notes
• Each application service end point can be accessed through the following URL:
https://{router-frontend-proxy-host}:{router-frontend-port} (for example, based on the screen shot
below, the SMP service end point for web applications at 
https://torvm-core05-smp.sigma-systems.com:9990, or the JWF/JEA service end point for web
applications at https://torvm-core05-jwf.sigma-systems.com:9990).
• The OSS/BSS systems that uses the OM JSR264 API will connect to https://torvm-core05-
api.sigma-systems.com:9990.
22
3 Create two smp-router containers on different hosts for redundancy. Enter the container name
and the URL details.
4 Click Submit.
23
5 Review the summary information, and then click Confirm to deploy.
Deployment Notes
• The above configuration assumes the network team has setup the following three DNS aliases:
• torvm-coredev1-api.sigma-systems.com
• torvm-coredev1-smp.sigma-systems.com
• torvm-coredev1-jwf.sigma-systems.com
(where each alias maps to hosts torvm-core05.sigma-systems.com and 
torvm-core06-sigma-systems.com).
• The router container will be down until you have configured the Sigma Provisioning applications.
24
Installing the Sigma Provisioning Application Nodes
Perform the following steps:
1 Login to Sigma Admin UI and select the Deployment Manager tab.
2 In the Application Name column, select smp to see the available Sigma Provisioning installation
profiles. Select a profile for deployment.
3 Fill in the database configuration for Sigma Provisioning CM and AM schemas. Note the
following:
• If using Oracle SERVICE NAME in the connection-string, use "/" between the port number
and the DB name.
• If using Oracle RAC, enable Fast Connection Failover (FCF) on the DB server, then configure
the Oracle Naming Service (ONS) in onsConfiguration in Sigma Admin, for example:
nodes=torracdscan.sigmasys.net:6200
25
4 Verify the cfg-repository configuration for Sigma Provisioning. The repository information is
dynamically set by Sigma Admin as it already knows the configuration-container details. Users
can override the cfg-repository configuration if necessary. Typically, the branch and tag/commit-id
information for the {project}-cfg repository should come pre-configured in the specification JSON
as part of the release. Users can also override them, if necessary.
26
5 Set up the SSL details required for Sigma Provisioning by configuring identity and trust store
details. The certs-folder points to the host-mount point where these jks files are stored.
27
6 If the implementation uses the Sigma Provisioning data encryption feature, then set up the secret
key store details as well.
7 Configure the implementation-specific environment configuration for components, such as JEA

and BSS adapters. You configure these components in the spec json as part development. During
deployment, Sigma Admin captures these values.
Note: The following screen shots show properties that are based on an SMP Demo
implementation. Your screens may look different.
28
8 Create and configure the application cluster nodes based on the smp-runtime Docker image.
• Container Name: Provide a unique Docker container name on the host. Name the container
based on its function in order to easily identify it. The following illustration shows an example
of adding the smp_svr2 suffix to the name.
• Docker Host URL: Provide the http URL of the Docker daemon on the host where this smp-
runtime container will be deployed.
• type: Node types are configured in the deployment profile as part of development. Node
types control the Sigma Provisioning application components that run in the container.
• ports: Specify the various ports used by application components. During deployment, Sigma
Admin bridges the ports from the Docker container to the host so they are accessible from
outside.
If an implementation includes components such as Async JEA, which needs a dedicated port,
the port must be modelled in the spec json as a container port. During deployment, Sigma
Admin captures the port value and configures it properly in the container to accept
connections from the outside world.
• host-logs-folder: Host-mount point where the application logs are written.
• vm-args: These are typically pre-configured in the json spec based on performance test
results.
29
30
9 Once the application node is configured, use the Duplicate icon to create additional nodes as
needed for the deployment.
10 Configure the tooling container that hosts the tools, scripts, and other utilities for Sigma
Provisioning.
11 Once all of the required properties are configured, click Submit.
Note: If the database tables are not set up before starting the application, Sigma Provisioning
won’t start. To avoid this failure, uncheck the Start Containers option before clicking Submit.
After the deployment, only start the smp-tooling node, run the database script, and then start the
applications (as described below). Sigma Admin will do the necessary validations and show the
summary of the configuration.
31
12 Review the configuration summary, then click Confirm to start the deployment.
Sigma Admin starts deploying all of the Docker containers. A deployment status link appears on
the screen. You can check the details of the deployment progress, details, status, or any failures
by clicking the link.
This screen also has a Download JSON file button that you can use to save the configuration for
later use in another environment. If there are any issues during the deployment, you can use the
Download Log file button to save the log for debugging.
32
Installing the Sigma Provisioning Database
Once Sigma Provisioning is successfully deployed, install the Sigma Provisioning database.
1 Go to Deployed Applications and start the smp-tooling container.
The status should change to RUNNING.

2 Once the container is up, from the host where the tooling container is running, log in to the tooling
container using the following Docker exec command:
docker exec ‐it {tooling_container_name} /bin/bash
cd ${SMP_HOME}/util
. ./setEnv.sh
cd ${SMP_HOME}/tools/com.sigma.samp.core/samp.util.install_db/install_db
./install_db.sh
The logs generated by the tool are under $SMP_HOME/db/install/db directory. This directory is
created when you run the tool for the first time.
3 Load the required Sigma A&A configuration for Sigma Provisioning. The smp54_am.dml file
contains the AM schema data exported from the previous Sigma Provisioning instance, and the
smp60_aa.dml file contains the configuration specific to the 6.x release.
Note: The actual .dml file names may be different based on the project.
cd ${SMP_HOME}/install/sigmaaa
sqlplus <AA_DB_USER>/<AA_DB_PASSWORD>@<DB_HOST>:<DB_PORT>/<DB_NAME>
SQL> @smp54_am.dml
SQL> @smp60_aa.dml
SQL> commit;
SQL> exit
4 Once the database is successfully installed, start all of the Sigma Provisioning nodes from Sigma
Admin.
33
Installing Sigma Provisioning Admin
1 Once Sigma Provisioning is successfully deployed, install and configure Sigma Provisioning
Admin as follows:
2 Configure the SSL details under global properties. The ssl-folder points to the host mount where
the jks files are stored.
3 Configure the smp-admin-runtime container details.
34
4 Click Submit.
5 Review and then deploy the container.
35
Integrating with Sigma Insights
Overview
As part of standardizing the Sigma Insights integration through Sigma Provisioning SysTimer events,
consider the following PoC. It shows how to stream the SysTimer events using fluentd to the Insights
Log Agent.
To enable Insights integration, perform the following steps:

1 Enable the Insights Event Logging global property from Sigma Admin when deploying the
Provisioning application.
• This in turn enables a new console appender to the logback configuration which streams the
SysTimer and notification events.
2 Enable the notification registry, NotificationEventLogger, for the order state change events in the
ordermgr_cfg.xml configuration file. This publishes some of the information needed by Insights
that was not part of the SysTimer events.
• With the standard notification registry, implementation teams can customize to include
properties and event filtering.
Note: This logger only supports the XML format currently.
3 For each application container, enable the Docker log driver and set it to journald.
• Implementation teams may choose to use other Docker log drivers by customizing the
deployment speficication json and associated scripts based on customer needs.
Note: docker logs {container‐name} can be used to see the journald logs for a container.
36
4 Deploy a fluentd agent on each host which is configured to filter the SysTimer and insights logs
from jourland on to an NFS, which is made accessible to the Insight agent.
Integrating with Sigma Insights
Perform the following steps to integrate Sigma Provisioning with Sigma Insights.
1 Set the global property insights-event-output to TRUE for Sigma Provisioning (if not already
configured).
2 Enable and set the Docker log driver configuration to journald for each of the smp-runtime
containers (if not already configured).
3 From the Sigma Admin UI, select the Deployment Manager tab and add the logging-fluentd
container.
37
4 Configure one fluentd container per host where Sigma Provisioning applications are deployed,
and then set the log folder to NFS MOUNT.
5 If the host is running with SELinux enforced, then set the optional docker SecurityOpt
configuration to label:disable (as shown below) so that the container can read the journal log
from the host.
38
6 Click Submit.
7 Review the configuration and click Confirm.
Once the deployment is complete, you can navigate to the Deployed Application screen in Sigma
Admin to see the status. You should also see the Sigma Provisioning Admin menu in Sigma Admin,
as well as links to the application home pages.
39
Administering Sigma Provisioning
Sigma Provisioning Admin provides a common platform to monitor and manage servers,
components, data sources and queues.
Home Page
To access the Sigma Provisioning Admin Home page, click the Provisioning tab on the Sigma Admin
UI.
The Sigma Provisioning Admin Home page appears.
40
The Home page summarizes the configuration and runtime status of each node and the logical
components. Information on this page includes servers and managed components.
Servers
The following information for each node is displayed:
• Name: The name of the node.
• Address: The host name of the node.
• Status: The status of the node. Possible values are:
• Active: The node is running.
• Shutdown: The node is down.
Managed Components
The Managed Components page shows managed and unmanaged Sigma Provisioning components.
The following information is displayed:
• Name: The name of the component.
• Status: The status of the component.
41
Servers Page
The Servers page lists the summaries of the configuration and runtime status of each node.
To access the Servers page, click the Servers tab from the home page. The Servers page appears.
The Servers page shows the following information:

• Address: The host on which the server is running.
• HTTP Port: The port on which the node is listening for the HTTP request.
• HTTPS Port: The port on which the node is listening for the HTTPs request.
• JMX Port: The port on which the JMX MBEAN server is listening.
• Clip Port: The port on which CLIP is listening.
42
Servers Detail
The Server Detail page displays the detailed configuration and runtime of a particular node.
To access the Server Detail Page, click the Servers tab from the home page. The Server Detail page
appears.
The Server Detail page shows the information described in the following sub sections.
Managed Components
The Managed Components page shows the following information:
• Name: The name of the component running on the node.
• Status: The status of the component. Possible values are:
• Active: The component is running and accepting requests.
• Suspended: The component is running and not accepting requests.
• Shutdown: The component is not running.
• Unmanaged: The component has no runtime to configure.
• Type: The type of Sigma Provisioning component, such as:
• ordermgr: Provisioning Order Manager.
• SmpWfEngine: Workflow Engine.
• sbjea{name}: Element Adapters.
• Work Pool Size: The size of the thread pool that processes the request of the component.
43
Data Source
To access the Data Source page, click the Data Source tab from the home page. The Data Source
page appears.
The Data Source page shows the following information:

• Name: The display name of the data source.
• Spec Name: The identifier of the data source.
• URL: The JDBC connection URL for this data source.
• User: The user that signs in to the data source.
• Driver Class Name: The class name of the JDBC data driver.
• Initial Pool Size: The size of the connection pool when the data source is created.
• Min Size: The minimum size to which the connection pool can shrink.
• Max Size: The maximum size to which the connection pool can grow.
Node Detail
The Node Detail page shows the following information:
• Address: The host on which the server is running.
• HTTP Port: The port on which the node is listening for the HTTP request.
• HTTPS Port: The port on which the node is listening for the HTTPs request.
• JMX Port: The port on which the JMX MBEAN server is listening.
• Clip Port: The port on which CLIP is listening.
44

Thread Pool
The Thread Pool page shows the following information:
• Name: The name of the thread pool.
• Current Task Count: The number of tasks currently waiting to be processed by threads in the
pool.
• Peak Task Count: The peak number of tasks waiting to be processed by threads in the pool since
the last server startup.
• Active Thread Count: The number of threads that are currently processing tasks.
• Peak Active Thread Count: The highest number of threads that are currently processing tasks.
• Current Thread Count: The number of threads that are currently in the pool.
• Peak Thread Count: The highest number of threads that have been in the pool since the last
server startup.
Controls
For each thread pool, you can use the following controls:
• Refresh: Refreshes the metrics of thread pools shown in the table.
• Monitor: Opens the Monitor Thread Pool page to display the variation of the metrics of the thread
pool over time, as shown below.
45
JVM Details
The JVM Details page shows the following information:
• Name: The full name of the Java Virtual Machine on which the node runs.
• Version: The version of the Java Virtual Machine on which the node runs.
• Start Time: The time when the node last started.
• Up Time: The number of seconds since the node last started.
• Heap Memory Usage: The current memory used in the Java heap against the maximum allowed
heap memory size in MB. The percentage of the maximum heap size currently used by the Java
Virtual Machine is also calculated.
• Non-Heap Memory Usage: The current non-heap memory used by the Java Virtual Machine
against the maximum allowed non-heap memory size in MB. The percentage of the maximum
non-heap size currently used by the Java Virtual Machine is also calculated.
• Thread Count: The current number of threads used by the Java Virtual Machine. You can display
and download the thread dump.
46
• Peak Thread Count: The maximum number of threads used by the Java Virtual Machine since
the last startup.
• Daemon Thread Count: The current number of daemon threads running on the Java Virtual
Machine.
• VM Argument: The command line argument passed in the Java Virtual Machine during startup.
• Classpath: The classpath of the Java Virtual Machine.
• System Properties: The current system properties of the Java Virtual Machine.
Controls
For each JVM, you can use the following controls:
• Monitor Memory: Opens the JVM Memory page to display the variation of the JVM memory
metrics over time.
• Display Thread Dump: Displays the thread dump of the JVM in the browser.
• Download Thread Dump: Downloads the thread dump of the JVM to a local file.
Note: If an application container needs to be restarted due to some issues, it is always recommended
to take a Thread Dump, which may be useful while investigate what went wrong.
System Properties
The System Properties section lists the names and values of the system properties of the current
Java Virtual Machine.
47
Components Page
The Components page summarizes the configuration and runtime status of each logical component.
To access the Components page, click the Components tab from the home page. The Components
page appears.
The Components page shows managed and unmanaged components.
Managed and Unmanaged Components
The Managed Components page shows the following information:
• Name: The name of the component running on the node.
• Status: A summary of the status of the component in the cluster.
• Type: The type of component, such as: com.sigma.jea.config.JeaSpec.
48
Component Details
The Component Details page displays the detailed configuration and runtime information of each
component, including the information of the Queues of the component.
To access the Component Details page, click a component name in the Managed Components or
Unmanaged Components section of the Components screen. The Component Details page appears,
as shown below.
Click the Customize link to display the following controls:

• Refresh Interval: Control the time interval, in seconds, between automatic refreshes of the metrics
for the destination.
• Start: Starts automatically refreshing the metrics for the destination.
• Stop: Stops automatically refreshing the metrics for the destination.
Destination Runtime Summary
The Destination Runtime Summary page shows the following information:
• Destination Name: The name of the queue.
• Target Server: The server on which the queue is running.
• State: The state of the queue. Possible values are:
• Running: The queue is running and accepting requests.
• Shutdown: The server on which the queue is running cannot be reached.
• Suspended: The queue is running but not accepting requests.
• Total Consumers: The worker pool size serving this queue.
49
• Busy Consumers: The current number of worker pools processing requests for this queue.
• Pending: The number of messages currently waiting to be processed in the queue.
• Current: The number of messages currently being processed in the queue.
• Peak: The maximum number of messages waiting in the queue to be processed.
Controls
For each queue, you can use the following controls:
• Suspend: Stops the queue from receiving messages.
• Start: Allows the suspended queue to start receiving messages again.
• Stop: Opens the Monitor Destination page to display the variation of the metrics of the destination
over time, as shown below.
50
Component Runtime
The Component Runtime page shows the following information:
• Target Server: The server on which this component is deployed.
• Status: The state of the component. Possible values are:
• Active: The component is running.
• Shutdown: The component on the target server is not running.
Controls
For each component request queue, you can use the following controls:
• Suspend Input: Stops the request queue of the component on the target server from accepting
messages.
• Resume Input: Allows the request queue of the suspended component on the target server to
start receiving messages again.
• Suspend All Input: Stops the request queue of the component on all servers from accepting
messages.
• Resume All Input: Allows the request queue of the suspended component on all servers to start
receiving messages again.
• Stop: Stops the adapter in the respective node and suspends the queues. This button is only
visible for fulfillment system components.
• Stop All Input: Stops the adapter in all nodes and suspends the queues. This button is only visible
for fulfillment system components.
• Start: Starts the adapter in the respective node and resumes the queues. This button is only
visible for fulfillment system components.
• Start All Input: Starts the adapter in all nodes and resume the queues. This button is only visible
for fulfillment system components.
Component Configuration
The Component Configuration page shows the following information:
• Type: The type of this component.
• Data Source: The data sources for which this component is configured to use.
Destination Configurations
The Destination Configurations page shows the following information:
• Component Name: The name of the component.
• Destination Name: The name of the queue or topic.
• Type: The type of destination. Possible values are Queue and Topics.
• Thread Pool Size: The size of the thread pool that processes requests from this destination.
51
• Auto Failover: If set to True, when one server running this queue is down, another instance of this
queue on a different server will process the request. If false, the message is not processed if the
assigned server goes down.
• Unit of Order: The value of the property that identifies to which group of Unit of Order this
destination belongs.
• Unit of Order Seq: The sequence used to generate the value of the unit of order.
• Redelivery Limit: The number of times the message is redelivered before the delivery is
considered failed.
• Redelivery Delay: The number of milliseconds after a failed delivery that a message is
redelivered.
• Error Destination: The queue or topic to which the message is sent after the configured maximum
number of re-deliveries have all failed.
• Max Throughput: The maximum number of messages that this queue or topic can process per
second.
• Transaction Timeout: The time in seconds after which a transaction will roll back if not yet
completed.
Customization
Click the Customize link to display the following control:
• Hide Column: Click the check box to hide the corresponding column
52
Destination Detail Page
The Destination Details page displays the detailed configuration and runtime information for each
queue. To access the Destination Details page, click a destination name under the Destination
Runtime Summary section of the Component Details screen. The Destination Details page appears,
as shown below.

• Refresh Interval: Controls the time interval, in seconds, between automatic refreshes of the
metrics of the destination.
• Start: Starts automatically refreshing the metrics for the destination.
• Stop: Stops automatically refreshing the metrics for the destination.
Destination Runtime Summary
The Destination Runtime Summary page displays the following information:
• Destination Name: The name of the queue.
• Target Server: The server on which the queue is running.
• Running wait: The queue is running and accepting requests.
• Total Consumers: The worker pool size serving this queue.
• Busy Consumers: The current number of worker pools processing requests for this queue.
53
• Current: The number of messages currently being processed in the queue.

• Peak: The maximum number of messages waiting t o be processed in the queue.
Controls
For each destination queue, you can use the following controls:
• Suspend: Stops the queue from receiving messages.
• Resume: Allows the suspended queue to start receiving messages again.
• Monitor: Opens the Monitor Destination page to display the variation of the metrics for the
destination over time, as shown below.
54
The Destination Configurations page displays the following information:
• Unit of Order: The value of the property that identifies to which group of Unit of Order this
destination belongs.
considered failed.
redelivered.
number of redeliveries have all failed.
second.
• Transaction Timeout: The time in seconds after which a transaction will roll back if not yet
completed.
Destination Runtime Details
The Destination Runtime Details page displays the following information:
• Target Server: The node on which the queue or topic is running.
• Alive: True if the server on which the queue is deployed is running. False if the server on which
the queue is deployed cannot be reached.
55

• RUNNING.wait: The queue is waiting for messages to process.
• RUNNING.makeExpiredMessage: The queue is scanning for expired messages so they can
be removed.
• RUNNING.scanExpiredMessage: The queue is marking messages for removal.
• RUNNING.invokeMessageRecoverAsync: The queue is recovering failed messages.
• RUNNING.scanFutureMsgQueue: The queue is scanning scheduled messages due for
processing.
• RUNNING.forwardMessageToHandler: The queue is sending messages to the handler for
processing.
• RUNNING.checkMessageVersion: The queue is checking if the message was updated by
another handler.
• RUNNING.forwardMessageToReceiver: The queue is sending messages to a receiver.
• RUNNING.invokeHandlerAsync: The queue is sending messages to a handler to be
processed asynchronously.
• RUNNING.scannUOO: The queue is scanning Unit of Order messages for processing.
• RUNNING.updateHeartBeat: The queue is updating the heart beat timestamp.
• Startup Time: The time when the queue or topic was last started.
• State Change Time: The time when the state of the queue or topic last changed.
• Buffer Size: The maximum number of messages that can be stored in the memory and awaiting
processing.
• Throughput: The current average number of messages processed per second.
• Current: The current number of messages being processed.
• Received: The number of messages received by the queue or topic since the node last started.
• Pending: The number of messages that are currently waiting to be processed in the queue or
topic, including those messages in memory and those that have been paged into the database.
• Error: The number of messages resulting in errors since the node last started.
• Aborted: The number of messages aborted since the node last started.
• Expired: The number of messages that have expired before being processed since the node last
started.
• Processed: The number of messages processed since the node last started.
• Version Unmatched: The number of messages dropped because the message is stale since the
node last started.
• Unassigned: The current number of messages not yet assigned to any particular server.
• Failed Over: The number of messages taken over by another instance after the assigned instance
crashed since the node last started.
56
• Ignored: The number of messages ignored because no suitable handler was found to process the
message since the node last started.
• Paged In: The number of messages loaded into memory cache from the database since the node
last started.
• Paged Out: The number of messages written to the database since the node last started.
• Ready Queue Current: The number of messages waiting to be processed in the memory cache of
the queue.
• Ready Queue High: The highest number of messages waiting to be processed in the memory
cache of the queue since the node last started.
• Future Queue Current: The current number of messages scheduled to run in the future.
• Future Queue High: The highest number of messages scheduled to run in the future.
• Total Consumers Count: The maximum number of worker pools processing requests for this
queue.
• Busy Consumer Count: The current number of worker pools processing requests for this queue.
You can click the Customize link to display the following control:
• Hide Column: Click the check box to hide the corresponding column.
57
Data Sources
The Data Sources page summarizes the configuration information for each data source. To access
the Data Sources page, click the Data Sources tab from the main menu. The Data Sources page
appears as shown below.
The Data Sources page shows data source runtime and configuration information as explained in the
following sub sections.
Data Source Runtime
The Data Source Runtime section displays the following information:
• Server: The name of the node to which the data source is deployed.
• Name: The display name of the data source.
• Active: The current number of connections serving requests.
• Idle: The current number of connections not serving requests.
• Waiting: The current number of requests waiting for an available connection.
• Average Active: The average number of connections serving requests since the node last started.
• Peak Active: The highest number of connections serving requests since the node last started.
• Created: The number of connections created since the node last started.
• Closed: The number of connections closed since the node last started
• Abandoned: The number of borrowed connections reclaimed after being idle for too long since the
node last started.
• Min Size: The lowest number of connections to which the connection pool can shrink.
• Max Size: The highest number of connections to which the connection pool can grow.
58
• Average Wait Time: The average time in milliseconds a request waits for an available connection
since the node last started.
• Peak Wait Time: The longest time in milliseconds a request waits for an available connection
since the node last started.
• Wait Timeout: The configured number of seconds a request waits for an available connection
before timing out.
• Peak Lifespan: The configured number of seconds since a connection was created until it is
closed if in idle state.
• Idle Timeout: The configured number of seconds after which an idle connection is closed.
• Statement Cache Size: The configured number of prepared statements cached.
• Validate SQL: The SQL statement to run for checking the health of the connection in the pool.
• Validate Before Use: If true, a connection is tested before being used.
Data Source Config
The Data Source Config section displays the following information:
• Spec Name: The identifier of the data source.
• URL: The JDBC connection URL for this data source.
• User: The user that signs in to the data source.
• Driver Class Name: The class name of the JDBC data driver.
• Initial Pool Size: The size of the connection pool when the data source is created.
• Min Size: The minimum size to which the connection pool can shrink.
• Max Size: The maximum size to which the connection pool can grow.
59
Queues
From the Queues tab, you can view message queues and message details. To access the Queues
and Messages pages, click the Queue tab from the main menu and make a selection from the drop
list as shown below.
Destinations
The Destination page lists the configuration of each logical queue.
You can click the Customize link to display the following control:
• Hide Column: Click the check box to hide the corresponding column.
60
The Destination Configurations page displays the following information:
• Component Name: The name of the component.
• Unit of Order: The value of the property that identifies to which group this unit of order destination
belongs.
considered failed.
redelivered.
number of redeliveries have all failed.
second.
• Transaction Timeout: The number of seconds until the message delivery expiries.
Messages
Messages Overview
The Message Overview page summarizes the distribution of messages in all queues and status. To
access the Messages pages, click the Queue tab from the main menu and select Messages.
The Message Overview page shows the following information:
• Destination ID: The identification of the queue.
• Destination: The name of the queue.
• Server: The node on which the message is assigned.
• Component: The component of the queue.
61
• Stage: The stage in which the message occurs. Possible values are:
• network: The message is being transferred across the network.
• db: The message is being saved to the database.
• dispatcher: The message is waiting to be dispatched to the handler for processing.
• ignored: No handler was found for processing this message.
• expired: The message has expired.
• State: The state in which the message occurs. Possible values are:
• new: The message is created in memory, not in persistence store.
• open.ready: The message is ready for processing and has a backup copy in the database.
• open.pending: The message is being processed in the message handler or receiver.
• closed.done: The message has been processed successfully.
• closed.ignored: No handler was found for this message.
• closed.expired: The message was not processed before it expired.
• closed.error: Handling of this message results in errors. The message will be redelivered.
• closed.dropped: Handling of this message results in errors even after redelivery.
• Count: The number of messages in the queue assigned to the node in the corresponding stage
and state.
Controls
For each message queue, you can use the following control:
• Show Messages: Displays the first page of messages in this destination.
Messages Page
The Messages page displays one page of summary messages in one queue.
62
The following information appears:

• Message ID: The identification of the message.
• Source: The node from where the message was sent.
• Target: The node to where the message is going.
• Create Date: The time when the message was created.
• Scheduled Date: The time when the message is scheduled to be processed.
• State: The state of the message.
• Stage: The stage of the message.
• Count: The number of messages in the queue assigned to the node in the corresponding stage
and state.
• Priority: The priority of the message.
Controls
For each page, you can use the following controls:
• Previous: Displays the pages of messages in this destination before the current page.
• Next: Displays the pages of messages in this destination after the current page.
Message Detail
The Message Detail page displays the detailed content of one message.
63
The following information appears:

• Message Headers: The headers associated with the message.
• Content: The content of the message in text format.
Controls
For each message queue, you can use the following controls:
• Resubmit: This feature is only enabled for an error queue. Any message resulting in an error is
moved to the request queue for processing again.
• View: Displays the message in text format so that the whole message can be copied as text.
• Drop: Manually removes this message so it is not processed.
Monitor Destination
• Refresh Interval: Controls the time interval, in seconds, between automatic updates of the chart.
• Start: Starts automatically updating the chart.
• Stop: Stops automatically updating the chart.
• Show/Hide: Displays the corresponding data set. Uncheck the box to hide the data set.
• Time Range: Displays the data set only within the selected time range.
64
Monitor Memory
• Start: Starts automatically updating the chart. The previous data set is removed.
• Garbage Collect: Runs the garbage collector on the server.
Monitor Thread Pool
• Start: Starts automatically updating the chart.
65
Service Profile Manager
The Sigma Service Profile Manager Web interface (SPM Web) provides flexibility and ease in
managing all aspects of a subscriber through a user-friendly interface, which allows digital providers
to do the following:
• Managing subscribers and their services
• Order capture and management, including manual tasks, event orders, scheduled orders, etc.
• Viewing and changing provisioning states
Service Profile Manager is designed to manage the complete life cycle of a subscriber, including
subscriber services and subscriber orders.
Subscriber profiles should be managed in the CRM, billing or other system of record for your
customers and the customer portfolio. One of the main functions of the Service Profile Manager is to
manage subscriber profiles outside of the system of record when an error or exception condition
occurs. SPM Web can add, update, delete, suspend and resume a subscriber as needed to ensure
services are delivered on time and accurately.
The subscriber’s profile is the information required in order to manage subscriber services. This
information may include name, address, account number, and other parameters determined by the
Digital Provider.
The SPM Web interface is designed for ease of use. All functions are logically organized under
various tabs, and wizards are available to guide you through the task of initializing services for a
subscriber.
The functions and data available in the user interface depends on your security access privileges. For
example, the administrator may access more functions than a CSR depending on the access
privileges.
66
Accessing Service Profile Manager
You can access the Service Profile Manager through a web browser. You must have a user name and
password, provided by either the Provisioning System Administrator or Database Administrator (DBA)
who maintains the Service Profile Manager system.
Logging in to Log in to Service Profile Manager
To log in to Log in to Service Profile Manager, perform the following steps:
1 Open Internet Explorer. Access to SPM Web is only through Internet Explorer.
2 Type the Service Profile Manager URL for the Sigma Provisioning 6.x domain in the address bar
(for example, http://193.168.1.11:5091/smpweb/)
The Sigma SSO login page appears.
If SSO is not enabled, you will see the SPM login page.
3 Enter the correct User Name and Password in the corresponding fields.
67
If you entered the wrong information, click Reset to clear the fields and re-enter the information.
The user name and password fields are case-sensitive.
4 Click Submit.
a. The interface may be configured to lock out users upon a predefined number of failed login
attempts. If you enter an invalid user ID and password three times, for example, your user ID
will become locked, thus preventing you from accessing Service Profile Manager. If this
happens, contact your system administrator for assistance.
b. If the memory has reached a certain predefined limit, the appropriate message is displayed
and recommends the action to be taken.
If the login information is correct and if there are no memory problems that require special
intervention, the Service Profile Manager Search page appears and lets you enter search criteria
to retrieve the desired data.
You may search for information using the options available:

• Search by Subscriber name
• Search by Len
• Search by Service Phone
68
Managing Subscribers
• Adding New Subscribers - Residential and Business
• Searching for a Subscriber
• Searching for a Large Subscriber
• Viewing a Subscriber's Profile
• Viewing Large Subscriber Services
• Changing Subscriber Status
• Editing Subscriber Information
• Editing Large Subscriber Information
Adding New Subscribers ‐ Residential and Business
The CSR and super use can register and manage subscriber accounts and their services.
Depending on your implementation, the Service Profile Manager may be used for:
• Maintaining subscriber accounts, for example, adding subscriber accounts, editing subscriber
information, changing subscriber status, and deleting a subscriber outside of the system of record
when necessary.
• Maintaining subscriber services.
• Checking unreturned service orders and executing manual tasks, such as modifying parameters
and resubmitting orders. Adding production users directly to Sigma Provisioning does not
establish the user in CRM, billing or any other system.
Adding a new subscriber in Service Profile Manager creates a record for that subscriber. Once the
subscriber is added successfully, you can perform operations such as ordering services and updating
subscriber information.
To add a new subscriber, perform the following steps:
1 Once you have logged in to Service Profile Manager, click the Subscriber tab.
Note: You may click Subscriber > New from any window to start adding a new subscriber.
The left navigation pane displays an expandable hierarchy tree.
69
2 Click the Subscriber Type arrow, then select the appropriate value (for example, “residential”).
3 Enter information in the provided fields.
Note: The provided fields depend on the configuration of the product and may be different in your
configuration.
70
4 To add a business subscriber, select “Business”.

Asterisks (*) indicate required fields.
The example illustrated in this task demonstrates adding a new residential subscriber requesting
high speed data, a complex voice line, on demand and voicemail.
5 Continue entering subscriber information, such as:
• Service Provider (for example, CableCompany)
• Billing Account
6 Enter Primary Contact information:
• Salutation
• First Name
• Last name
• Initials
• Primary Phone Number
Format validations are usually in place. For example, 10-digit telephone number with no
parentheses or dashes.
7 Enter Primary Contact Address:
• Street Number, for example, “55”
• Street Name, for example, “York Street”
• City, for example, “Atlanta”
• Country
• State, for example, “New Jersey”
• Postal Code: The postal code or zip code is specific to the address and jurisdiction. The
appropriate error message is displayed when the format entered is not valid
• Select Headend, Node, Rate Center, Service Areas, Return Segment, or any network
elements the subscriber will be associated with from the drop-down lists provided in your
implementation
8 Depending on your configuration, you may have entities that are associated with the subscriber.
Depending on your specific entities, the relevant windows will be displayed in sequence. Enter the
information required by your business rules. For example, defining a site survey in association to
a subscriber. The Site Survey may not exist in your implementation. This is just an example of the
capability of the interface to handle various entities in association to the subscriber.
The site survey can be updated when adding a subscriber (for example, by associating the
subscriber address to the subscriber).
9 Depending on the practices and configuration:
• Continue to add services for the subscriber
• Submit the subscriber information as a separate order using the Shopping Cart Utility
71
Searching for a Subscriber
Service Profile Manager provides a choice of search options. You may search for a particular
subscriber, using their name, telephone number, account number or other search criteria provided
depending on your implementation.
Once you have logged on to the Web interface, the Search Subscriber window appears with the
Search tab open by default. From here, you can search for a subscriber's record.
You can search for a subscriber using the available search options.
To search for a subscriber, perform the following steps:
1 Log in to Service Profile Manager as described in the Accessing Service Profile Manager section.
The Search Subscriber window appears by default.
2 Select one of the search options by clicking the radio button nearer to the search option. For
example, Search by Name, By Account Number, etc.
3 Enter the required information for the search option selected above. For example, for Search by
Name option, enter the first name and the last name of the subscriber.
If you have entered the wrong information, click Reset, then re-enter the correct information.
4 Click Submit.
Search results are displayed based on your search criteria.
• Zero results are returned when no match is found for your search criteria. In this case, check
and re-enter search criteria, then resubmit.
• Multiple records matching the search criteria may be retrieved in the Search Results window.
72
• If the list is longer than the page, click Next or Back as appropriate to browse the search
results pages.
• Search results contain information particular to each subscriber listed, such as the
subscriber's first and last name, home phone number, and status, for example, “active”.
• Once you locate the desired subscriber in the retrieved list, click any of the hotlinks provided
for that subscriber. The Subscriber View window is displayed.
• Specific subscriber information is retrieved and displayed in view mode.
5 Use the Refine Search option to return to the search and narrow down your search criteria. To
search for another subscriber, click the Search tab and begin the search process again.
To view the scheduled or held orders for the subscriber, perform the followings steps:
1 Search for a subscriber using the normal procedure.
When the subscriber is displayed, an icon in the subscriber tree will visually notify you that there
are pre-queued orders in the system for the subscriber.
2 Click the Orders tab.
3 Search for pre-queued orders for the subscriber based on the order status. Process orders as
needed.
73
Searching for a Large Subscriber
To ensure support for a larger number of lines per subscriber in the context of commercial services,
the platform is designed to support business subscribers that have as many as 99999 business voice
lines.
Large subscriber services are not fully loaded in memory. Instead, their services are configured to be
loaded selectively.
You can retrieve a large subscriber by following the standard search.
To search for a large subscriber, perform the following steps:
1 Log in to Service Profile Manager. The Search Subscriber window appears by default.
2 On the Search page, select the desired search option and enter the required information.
3 Click Submit.
The records matching the search criteria submitted are retrieved.
4 Click the desired large subscriber.
The Subscriber window opens in view mode. The left pane displays the list of services. If present,
the magnifier icon indicates that more services can be loaded selectively for that service.
Viewing a Subscriber's Profile
The subscriber's profile contains information such as the subscriber's status (for example, “active”), a
contact address, an account number, etc.
The Service Profile Manager allows you to view the subscriber profile for any newly added or existing
subscriber.
To view a subscriber’s profile, perform the following steps:
1 Log in to Service Profile Manager.
2 Search the existing subscriber using any of the search options. For example, search by
subscriber name.
3 Select the subscriber by clicking the subscriber account number. If you have just added a new
subscriber, simply click the View link under the Subscriber tab.
The Subscriber window appears in view mode.
Note: You may first need to search the subscriber if you wish to view the profile of an existing
subscriber.
4 Verify the subscriber information.
Once you have added or retrieved a subscriber, you can view a summary of the subscriber's account.
To view the current subscriber's summary, perform the following steps:
1 In the Subscriber tab, click View.
A new window containing the subscriber profile appears.
74
2 Click Add/Edit to edit the information as required. Click Update Cart on the Shopping Cart page to
submit the order.
The check mark symbol displayed in the left navigation pane means that a required action has
been fulfilled.
Viewing Large Subscriber Services
You may view a large subscriber profile, which will also show all services associated with the
subscriber. However, unlike other subscribers, a large subscriber may not have all the subscriber
services displayed.
To view large subscriber services, perform the following steps:
subscriber name.
3 Select the subscriber by clicking the subscriber account number.
4 In the left navigation pane, click Services.
A Subscriber Details window appears.
75
The information pane shows subscriber information. The navigation pane shows the services
associated with that subscriber account. The number next to the service shows the number of
services loaded and the number of services the subscriber has in their profile.
The details window will refresh and shows search fields.
5 Enter the search criteria and click the Search option.
The details of the services are displayed.
6 Select one or more services, then click Load Selected. This loads the subscriber information.
You can hold down the CTRL key to select more than one subscriber.
Note: Services already loaded in memory are highlighted in the list of services.
7 Verify the subscriber information.
Changing Subscriber Status
Service Profile Manager allows you to make changes to a subscriber’s status. For example, you can
block, delete, or resume services for a subscriber.
To change a subscriber’s status, perform the following steps:
subscriber name.
4 In the Subscriber tab, click Actions when the subscriber is already displayed in the active
session.
The Subscriber Actions window appears.
76
The type of actions displayed depend on the current status of the subscriber:
• If a subscriber is currently active, the window presents options such as Courtesy Block and
MSO Block options.
• If a subscriber has been previously suspended, options such as resume are available to
reinstate or delete the subscriber.
• You may delete a subscriber at any time
• You may re-provision the subscriber
5 Click the appropriate action (for example, Courtesy Block). The action and its description are
given below:
• Courtesy Block (active subscribers): Suspends services on subscriber’s request.
• Delete (active subscribers): Deletes a subscriber (for example, when a subscriber has chosen
to discontinue services or if the subscriber is still delinquent).
• MSO Block (active subscribers): Suspends services for an undetermined amount of time (for
example, the subscriber has not paid his or her bills).
• Resume (suspended subscribers): Resumes a service if the subscriber had been suspended
due to an MSO block when the subscriber is no longer delinquent.
6 Select a reason in the Reason Code field (required): For example, other.
7 Enter comments in the Reason Note field (optional): For example, Suspend for some time.
8 Click Update Cart to submit the status change.
The Shopping Cart window is displayed. All the subscriber’s services are listed in the cart if the
status change is at subscriber level.
Note: You may also suspend specific services only for a subscriber.
9 In the Shopping Cart page, click Submit Order.
The order is created and the subscriber is suspended.
The subscriber services can be resumed upon request or after the subscriber has made the required
payments.
Editing Subscriber Information
Service Profile Manager lets you edit the existing subscriber information. You may retrieve an existing
subscriber for editing or edit a newly added subscriber.
To edit the subscriber information, perform the following steps:
subscriber name.
4 In the Subscriber tab, click Add/Edit. You can also click the Subscriber link in the Shopping Cart.
The subscriber window appears in editing mode.
77
5 Overwrite information as required, then click Next.

The CSR is not required to perform any further action. For example, when the value of the
subscriber’s first name or last name changes, the appropriate orders are submitted automatically
to perform all the necessary changes to relevant parameters, such as voicemail name, etc.
The Shopping Cart window appears.
Once the order is complete, all the data repositories are updated as needed.
Editing Large Subscriber Information
Editing large subscriber information follows a process similar to the one for smaller subscribers. The
only difference is that the subscriber's services that are changing must be loaded into memory first
using the “Searching for Large Subscribers” process.
To edit large subscriber information, perform the followings steps:
subscriber name.
4 In the Subscriber tab, click Add/Edit. You can also click the Subscriber link in the Shopping Cart.
The subscriber window appears in editing mode.
5 Overwrite information as required, then click Next.
Once the order is complete, all the data repositories are updated as needed.
78
The user can choose to reload the subscriber with the services that were previously loaded into
memory, or just reload the subscriber.
If you have elected to reload the subscriber, then the base subscriber information is displayed. If
you have elected to reload the subscriber and services, you will see the subscriber and the
(partially) loaded services.
Managing Orders
• Searching for an Order
• Viewing an Order
• Creating a Scheduled Order
• Editing Scheduled Order Start Date
• Editing Scheduled and Held Order Details
• Creating and Holding an Order
• Releasing a Held Order for Processing
• Scheduling a Currently Held Order
• Releasing a Scheduled Order for Processing
• Canceling Scheduled and Held Orders
• Creating Multiple Orders for a Subscriber
• Capturing Event-Based Orders
• Processing Pre-Queued Orders
• Processing Aborted Orders
• Canceling a Failed Order
• Repairing a Failed Order
• Error Messages and Retries
Searching for an Order
Once you have logged in to SPM Web, the Search Subscriber window appears with the Search tab
pre-selected. From here, you can click Orders to perform an order search.
To search the order, perform the following steps:
1 Log in to Service Profile Manager. The Search Subscriber window appears by default.
2 In the Search tab, click Orders.
The Search Order page appears.
79
3 Select one of the search options by clicking the radio button. For example, Search by Order
Status.
4 Enter the required information for the search option selected above. For example, State: Closed
Completed All.
If you have entered the wrong information, click Reset, then re-enter the correct information.
5 Click Submit. Search results appear:
80
• Zero results are returned when no match is found to your search criteria. In this case, check
and re-enter search criteria, then resubmit.
• Multiple records matching the search criteria may be retrieved in the Search Results window.
Records extracted may be listed on multiple pages, along with information such as Order ID,
Order State, Created By, etc.
6 Double-click the appropriate order from the Search Results table. The details of the selected
order are displayed in the right pane.
Once the order is retrieved, the interface switches automatically from the Search tab to the Orders
tab.
To search for another order, click the Search tab, and then begin the search process again.
7 Use the Previous Results button to display the results of the previous search, and the Refine
Search button to modify the search criteria.
To search for a pre-queued order, perform the following steps:
a. Click the Search tab.
b. Enter the status and date range for the order.
Only parameters on the order header can be used in the search as defined in the
configuration of the named query.
SPM Web displays a list of orders that match the selection criteria.
c. Select the appropriate order from the list. SPM Web displays the order in the Orders tab and
shows order details, including line items and parameter values.
Note: Pre-queued orders (scheduled or held orders) cannot be searched based on order
detail information. For example, if an order search is required based on the telephone number
of the voice line service, then this is only possible if the telephone number is included as an
order header parameter.
81
Viewing an Order
Once you have searched for and opened a subscriber’s account, you can view all the orders and the
status of the orders for that subscriber. The Orders window shows all subscriber orders regardless of
the subscriber’s status; the most recent order is listed first.
Each order has a unique identifier. An order may contain many line items, representing different
provisional actions on the account. These details are shown when the order is selected.
To view an order, perform the following steps:
subscriber name.
4 Click the Orders tab once the subscriber is loaded.
The Orders window is displayed with the View link pre-selected. The navigation pane lists the
orders with the most recent one first.
5 From the navigation pane, select the order whose details you wish to see.
The information pane displays the order details and the status for each order detail. If there are
failed orders, you may want to cancel them.
6 Click View Workflow to display the Workflow Console Applet.
7 Use the scrolling tool in the top right corner to view the desired area of the graph.
82
To View Queued Orders

1 Retrieve orders that are queued for the CSR following the regular search procedure.
2 Once the list of orders appears, select the relevant order to view its details.
3 Analyze the order and process as required: cancel, replicate or add a new order in case the order
has failed to set the status of the aborted to flag the order for details.
To View Event Orders
1 Retrieve orders that are queued for the CSR following the regular search procedure.
Once the list of orders appears, select the relevant order to view its details.
2 Analyze the order and process as required: cancel, replicate or add a new order in case the order
has failed to set the status of the aborted to flag the order for details.
The parameter detail information is displayed in the order line item detail window when an event
service is added. Queries can be created against the parameters of an event service.
Creating a Scheduled Order
Long running orders such as voice or commercial services require services to be activated on a
specific date. The order provisioning activity should not start until the appropriate time prior to this
date. Additionally, the customer may request that the due date be changed at any time, while the
order is in progress.
Commercial orders may also have some additional due date requirements. For example, there may
be need to capture multiple due dates such as installation date, service test date, and service launch.
These dates may also be changed at any time.
Sigma Provisioning provides the ability to capture scheduled orders, including the ability to edit the
due date and start date at any time prior to order submission. Once the start date has been specified,
the order becomes a scheduled order.
Scheduled and held orders may be retrieved for further processing.
To create a scheduled order, perform the following steps:
2 Click the Subscriber tab.
3 Create a service order following the normal procedure.
4 Once you have completed the service wizard, in the Shopping Cart window, enter the start date
and time of the order. Optionally, enter the due date of the order.
83
5 Click Submit Order.

Sigma Provisioning validates and saves the order for processing on the start date. The status of
the order is now “open.not_running.pre-queued.scheduled” and the order will be executed on the
scheduled date.
If the start date is prior to the current date, the order is processed as soon as it is submitted.
Editing Scheduled Order Start Date
SPM Web allows you to edit the start date of a scheduled order.
To edit the scheduled order start date, perform the following steps:
2 On the Search page, click the Orders tab, then search for the order based on state and date. For
example, use query Search by Order status and Created Date.
3 Optionally, if multiple records are retrieved, double-click a record to select an order.
4 Switch to the Orders tab (if not displayed by default) and display the order in the shopping cart.
5 Edit the start date of the order. Optionally, edit the due date of the order. In addition, you may
update the pre-requisite order ID.
the order is now “open.not_running.pre-queued.scheduled” and the order will be executed on the
scheduled date.
84
You can update the scheduled order start date using the SPM Web.
If the start date cannot be updated, consider these possible reasons:
• Edit option is not enabled when you do not have the authority to update the order
• Subscriber may have changed (if externally sourced); the order can no longer be merged with the
current version of the subscriber
• Processing of the original order may have started while making the changes
• Start date is prior to the current date
Editing Scheduled and Held Order Details
SPM Web allows you to edit scheduled and held order details.
To edit a scheduled order, perform the following steps:
2 In the Search page, click the Orders tab, then search for the order based on Order ID.
3 Optionally, if multiple records are retrieved, double-click the record to view the order.
4 If not displayed by default, switch to the Orders tab.
5 Click Edit.
6 Select the service to be edited. The service wizard will guide you through the appropriate steps.
When clicking the Edit option, the GUI merges the content of the order to the current state of the
subscriber, thus obtaining the same picture the user had before submitting the order. Now, the
user can change any detail about the order including its start date and hold order flag, and
resubmit the order. When editing an order, any order header parameter populated in the order will
be pre-set when viewing the shopping cart page.
7 Update the order details as required.
8 Click Submit Order to submit the order.
the order is now open.not_running.pre-queued.scheduled and the order will be executed on the
scheduled date.
If the subscriber has changed in such a manner that the pre-queued order cannot be applied, an
error message is displayed. For example, the pre-queued order is trying to update the parameter
of a service that has been deleted.
The possible reasons are:
• Edit option is not enabled when you do not have the authority to update the order
• Subscriber may have changed (if externally sourced); the order can no longer be merged with
the current version of the subscriber. For example, an order containing a change to a feature
cannot be processed if another order has deleted the phone number
• The processing of the original order may have started while making the changes
85
Creating and Holding an Order
SPM Web allows you to create an order and put it on hold.
To create an order and put it on hold, perform the following steps:
2 Click the Subscribers tab.
3 Create a service order following the normal procedure.
4 In the Shopping Cart window, select the Hold Order Flag check box.
Sigma Provisioning validates and saves the order. The order is not processed as long as it is
flagged as held. The status of the order is now open.not_running.pre-queued.held.
To put a scheduled order on hold, perform the followings steps:
1 Search for the order following the normal search procedure.
3 If not displayed by default, switch to the Orders tab. The order details appear.
4 Select the Edit option.
5 Switch to the Shopping Cart window.
6 Select the Hold Order Flag check box.
the order is now open.not_running.pre‐queued.held and will not be executed until released.
86
If the order cannot be processed (fails), consider these possible reasons:

• The Edit option is not enabled when you do not have the authority to update the order
• Subscriber may have changed (if externally sourced); the order can no longer be merged
with the current version of the subscriber. For example, an order containing a change to a
feature cannot be processed if another order has deleted the phone number
Releasing a Held Order for Processing
You can release the held order for processing using SPM Web.
To release a held order, perform the following steps:
1 Log in to SPM Web and click the Orders tab.
2 Search for held order based on Order ID (for example, Using Query Search by Order ID).
Parameters in the order header can be used in the search as defined in the configuration of the
named query.
3 Select order to be updated.
The order is displayed in Orders tab.
The order details appear in the Shopping Cart window.
5 To remove the hold on the order, clear the Hold Order Flag check box.
The order will be processed on the start date. If the start date has passed, then the order will be
processed immediately.
Scheduling a Currently Held Order
SPM Web allows you to schedule the currently held order for processing.
To schedule a held order for processing, perform the following steps:
1 Log on to the SPM UI, click the Orders tab, then search the order based on Order ID.
named query.
2 Select order to be updated.
3 Click the Edit option.
The order details are displayed in the shopping cart window.
4 Remove the hold on the order by clearing the Hold Order Flag check box.
5 Select a start date in Start Date Time or modify the existing start date.
6 Click Submit Order on the shopping cart to submit the order.
The order will be processed on the scheduled start date.
87
Releasing a Scheduled Order for Processing
SPM Web allows you to release a scheduled order for processing.
To release a scheduled order, perform the following steps:
1 Log in to SPM Web, click the Orders tab, then search the order based on Order ID.
named query.
2 Select the order to be updated.
The order is displayed in the Orders tab.
3 Click the Edit option.
The order details are displayed in the shopping cart.
4 Remove the start date from the Start Date Time field.
5 Click Submit Order in the shopping cart to submit the order.
The order will be processed immediately.
Canceling Scheduled and Held Orders
You can cancel Scheduled and held orders. All the line items in the order will close.
To cancel scheduled and held orders, perform the following steps:
1 Log in to SPM Web, click the Orders tab, then search the held order based on Order ID.
named query.
2 Select the order to be updated.
3 Click Cancel to cancel the order.
The order will be processed immediately.
The Service Profile Manager confirms that the order was canceled (closed and aborted).
The entire order is removed. The status of the order is now closed.aborted_by_client.
If the order cannot be processed (fails), consider the following possible reasons:
• If the scheduled order selected has been executed or is currently being processed, it cannot
be canceled
• If start date and time of schedule order passes while the order is updated, the order cannot be
canceled
88
Creating Multiple Orders for a Subscriber
The CSR can create multiple orders for the same subscriber: a held order, a scheduled one, and one
to be executed immediately. All of these orders can be event-based or regular orders for a subscriber
that is externally sourced.
To create multiple orders for a subscriber, perform the following steps:
1 Log in to SPM Web, click the Subscribers tab, then create a service order following the normal
procedure.
2 Submit the order for immediate processing in the shopping cart window.
3 If required, you may enter a scheduled or a held order for the same subscriber by using order
search on smpweb.
4 Later, release the held order for processing as needed. The scheduled order is released for
processing.
If the order fails, it may be possible that the entity has changed: between the time the order was
created and the time the order was processed, the subscriber may have changed in such a
manner that the order will fail and it is set to closed.aborted_by_server; cancel the order.
Capturing Event‐Based Orders
Event-based orders may be captured, scheduled, and held. They may also be viewed in the Orders
tab. An event service has the attribute persistence type in its definition set to “event”. You may add,
modify, delete, suspend, and resume even-based orders in a similar manner to any other orders.
AM controls event orders that a CSR can see, capture or modify, and what actions they can perform.
When capturing an order, a drop-down box with the possible actions is provided next to the service.
If an event service is a composed service, all the services in its composition are event services. Also,
the children of a composed event service will all have the same action as the parent.
The order capturing process is identical with the one for persisted services.
For suspend, resume and delete actions, parameters marked as primary key are the ones required to
be captured.
For event-based services, check boxes have three states. A value may be left empty, or set to “true”
when checked with a check mark, or set to “false” when checked with an “x” mark.
Text boxes support an “empty” value. To request this value, use the F2 key. When the text box is in
empty state, it changes its color and its value is “_empty_”. Typing in a text box reverts it to its legacy
behavior.
For the change action, the only required parameters are the ones marked as primary key. All other
parameters are optional and validations are only completed on changed parameters.
To capture an event-based order, perform the following steps:
2 In SPM Web, in the Subscriber tab, click Services in the left pane, then click the Add/Edit link.
The Add Orderable Services window appears.
89
3 Enter the quantity for the service ordered and select the desired action.
4 Click Next to enter parameters for the service. The service is displayed with all parameters
available for entry. The parameters are displayed based on the capture sequence configured.
Parameters are hidden, displayed and read-only based on the privileges set up for the user in the
AM configuration.
5 Enter the required information for the order.
SPM completes validation on the parameters entered: for an add action, SPM validates all
parameters:
• For a delete action, SPM validates the key parameters
• For a change / suspend / resume action, SPM validates the key parameters and the
parameters that have been identified as changing.
6 Resolve any errors before continuing to the next service in the order.
7 Continue entering processes until all services have been entered.
SPM completes validation on the parameters. The CSR must resolve any errors before continuing
to the next service in the order.
8 When all services have been entered, click Next to display the Shopping Cart window.
The event services, regardless of the action selected, are added to the cart. The user can go back
and change any parameter values at any time before submitting the order, except for the action
initially selected to be performed on the service.
90
Validation rules are not executed for all parameters. They are only executed on the parameters
that the user identifies as changing.
9 Select the Hold Order Flag check box (if required).
10 To enter a different action for the same service, after entering the details for the service for the
initial action, return to the initial menu. Select the same service type with a different action (a new
line item is created in the order).
11 Click Submit Order In the shopping cart to submit the order.
Network actions will be associated with service actions for event based services.
Processing Pre‐Queued Orders
Users may search all orders in Sigma Provisioning, including orders that are queued or in progress,
scheduled orders, and held orders.
Pre-queued orders include the following:
• Orders with the Prerequisite Order Id
• Orders with the start date
• Orders that have been held
Parameters for all pre-queued orders are added to the order database so that they are available for
search and modification.
When an order is in the shopping cart, you may also identify any pre-requisite event order by entering
the appropriate event order ID. This would be checked before submitting the order for processing,
and the order would be held until the pre-requisite order is completed.
Order dependencies may also be automatically configured by the BSS system or the BSS adapter.
To edit a pre-queued order, perform the following steps:
2 In SPM Web, search for the order based on the start date (for example, using query Search by
Created Date).
4 If not displayed by default, switch to the Orders tab.
6 Select the service to be edited. The service wizard guides you through the appropriate steps.
7 Update the order details as required.
8 In the Shopping Cart window, click Submit Order to submit the order.
the order is now open.not_running.pre‐queued.scheduled and the order will be executed on
the scheduled date.
91
If the order cannot be processed (fails), consider the following possible reasons:
• Subscriber may have changed (if externally sourced); the order can no longer be merged with
the current version of the subscriber. For example, an order containing a change to a feature
cannot be processed if another order has deleted the phone number
• The processing of the original order may have started while making the changes
CSRs may identify a pre-requisite order by Order ID to prevent the processing of the dependent
order until the pre-requisite order is processed.
To identify a pre-queued order for a dependent order, perform the following steps:
1 Capture an order by searching an order using the search option.
2 Identify that it is dependent on the completion of another order by entering an smp_ordr_id in the
Shopping Cart window.
If the pre-queued order is not successful, then the dependent order will not be processed until the
pre-queued order is completed successfully.
Processing Aborted Orders
Invalid orders are aborted.
When the CSR signs into SPM Web, an icon is displayed beside the user name to indicate that they
have aborted orders.
To process aborted orders associated to order status, perform the following steps:
2 In SPM Web, search the order based on the order status (for example, using query Search by
Order Status).
3 Click the aborted orders to display details.
4 Take the required action: replicate the order or add a new order. Once the order goes through, the
aborted order will be flagged as resolved and will no longer be retrieved for the same query.
Canceling a Failed Order
Your business rules will determine how and when to change the status of an order.
For example, failed, scheduled, or held orders can be canceled. All the line items in the order will be
closed if the order was not successful.
To cancel a failed order, perform the following steps:
2 In SPM Web, search the order by order status (for example, using query Search by Order Status).
The search results display the orders with failed status.
3 Locate the failed order, select it in the left pane, then click Cancel.
Service Profile Manager confirms that the order was canceled (closed and aborted).
The entire order is removed.
92
If you wish to submit a new order, search subscriber again for failed order, then repeat steps 1
and 2.
4 Check the left pane to see the status change for the order.
Repairing a Failed Order
TSRs, CSRs, and Superusers can view a history of all the orders for a subscriber, and they can
change the status of an order. The SPM Web UI can be used to capture and provide management
interfaces for both subscriber-based and event-based orders.
Aborted or partially completed orders can be repaired in the Sigma Provisioning Web Order window
using the Repair option.
This Repair option has the ability to fix and resubmit failed Line Items from a closed Order, which is
either in fully rolled back or partially completed state.
You can review the failed Line Items to identify the errors that lead to the rollback of failed items.
The repair order contains all the line items and all the order header parameters in the original order.
One additional order header parameter, original_ordr_id is added. This parameter contains the
order ID of the problem order. This task demonstrates how to repair the failed order using the SPM
Web UI.
To repair a failed order, perform the following steps:
2 In the Search page, enter the ID of the order that you want to repair.
3 Click Submit.
The order page appears. The Repair options for Orders are in following closed state:
• Closed.Completed.Partially
• Closed.Aborted
4 Click Repair.
The Shopping Cart page appears.
5 Click the Failed Line Item (for example, DOCSIS Internet Access).
The DOCSIS Internet Access window appears
6 Fix the service parameter value that lead to order failure (for example, Configuration File), then
click Next.
7 In the Shopping Cart window, click Submit Order.
In the Subscriber tab, the subscriber profile is updated. It reflects the items in the order with the
original values from the failed order.
Also, there is an order level parameter called Original Order ID with value set to the original failed
order ID.
Once the Repair order is submitted, Sigma Provisioning marks the original failed order as
resolved by setting “Resolved Indicator” order parameter to “y”. Also, the Repair option is disabled
from the original failed order.
After the repairing order completes successfully, any orders that are dependent on the original
order are initiated.
93
Error Messages and Retries
When an orders fails, the platform retries the request and eventually moves the message to
com.sigma.jms.samp.ordermgr.OrderReadyQueue$error. If there was an order search,
SPM Web shows the following details:
Managing Batches
• Creating a Batch
• Searching for Batches
• Replicating Orders in a Batch
• Adding Orders to a Batch
Creating a Batch
Users can submit orders in batches (for example, submitting orders for business customers). The
need to re-enter common information across similar orders is eliminated through batch processing.
Also, batches provide the ability to manage and execute these orders as a batch. A batch is created
when creating the initial order for that batch.
To create a batch, perform the following steps:
2 Search the existing subscriber using any of the search options (for example, search by subscriber
name).
4 Click Services in the left pane, then select the Add/Edit link.
The Add Orderable Services window appears.
94
5 Perform the following tasks:

a. Enter the quantity for the service ordered.
b. Select the Create New Batch check box.
c. In the Batch Description box, enter the batch description.
6 Click Next and complete the order entry in the windows provided by the service wizard.
If you select the Create New Batch flag, then click Next, going back and clearing the flag will not
prevent the creation of the batch. The only way to remove the flag is to refresh / reload the
subscriber.
7 Enter the required information for the order.
8 Select the Hold Order Flag check box (optional).
Note: If you enable the Hold Order Flag, you can then manage the individual order in the batch at
a later time. However, if the Hold Order Flag is not enabled, the individual order is processed as
soon as it can be. As a result, when you go to the batch screen, you won’t be able to manage it as
an individual order.
The “Order Submitted” message appears with Order ID and Batch ID.
SPM has generated order header parameters including a batch ID and batch description. More
orders can be added to the same batch.
10 Click Replicate to continue entering orders for the same batch by replicating the submitted order.
Not all orders can be replicated.
95
To take ownership of a batch, perform the following steps:

1 Retrieve the batch using the Batch ID created in Sigma Provisioning. An existing batch must
contain at least one order.
2 In the Batch Management window, click Take Ownership.
The table is scrollable and resizes with the page while keeping the bottom section that contains
the buttons always visible.
The batch management window displays a list of all the orders in the batch. The window assigns
a sequential number to the orders being displayed.
• If the batch does not have an owner, the CSR can take ownership of the batch.
• If the CSR currently owns the batch, the CSR can release ownership of the batch to allow
another CSR to take ownership.
When users do not have ownership of the batch, they cannot make changes to the orders in the
batch.
To process the batch, the following buttons are available at the bottom of the window:
• Reset Selection: Deselects an order
• Submit Now: Submits selected order for processing
• Cancel: Cancels the selected order
• Update Order Parms: Retrieves a pre-queued order and modifies its parameters. A pop-up
window appears in which you can make changes.
• Build Dependencies: Sets dependencies between the orders in a batch. This creates sequential
processing of the orders. For example, order 123 must successfully complete before order 124 is
processed.
Note: The Build Dependencies button is used to build a prerequisite order processing sequence
based on the selected orders in the current sort order. This means that you might encounter
orders that are currently sorted in reverse according to their order ID. This would make the
dependencies backwards. There also might be an order in the batch that is not part of the
dependencies list and has no check box. It is important to note here that only orders that remain
in an editable or unprocessed state can be managed. Therefore you may encounter an order at
the bottom of your list that is in the closed.aborted state. This means that it is in an uneditable
state and cannot be managed from this particular batch screen. This is a reason why it may help
to have the Hold Order Flag enabled (see the Note in the Step 8 optional instructions above on
selecting the Hold Order Flag check box for more information). With this flag enabled you can
manage all of the orders and submit them all at once.
Once the dependencies are built, a pop-up window appears for the CSR to make the following
changes:
• Release Ownership: Allows another user to take ownership of the batch
• Add Order: Adds a new order to the batch
• Status Summary: Lets you view the status of the batch
• Print List: Prints the list of orders in the batch
96
Searching for Batches
Once you have logged in to SPM Web, the Search Subscriber window appears with the Search tab
pre-selected. From here, you can select the Batch hot link to perform a batch search.
To search for batches, perform the following steps:
1 Log in to SPM Web.
2 In the Search page, click the Batch hot link to perform batch search.
3 Enter the Batch ID, then click Submit. A list of orders appears.
4 Click the required order, or use the options at the bottom of the screen to add an order, print the
list of orders, or view a summary for the batch.
The Print List, Status Summary and Refresh options are displayed for all CSRs. The Take
Ownership option appears if there is no owner for the batch.
If you choose a particular order to view, then want to return to search, click the Search tab, Batch
hyperlink, and the Previous Results option.
To search for another batch, enter a different Batch ID, then click Submit.
Replicating Orders in a Batch
The Replicate function creates a copy of the order including order header parameters, line items and
line item parameters. If a batch ID is associated with the order being replicated, the new order will be
included in the respective batch. You can then edit any parameters that need to change, and repeat
the process.
The Replicate feature is available to authorized users.It creates a copy of the order, including order
header parameters, line items and line item parameters. The CSR can then edit any parameters that
need to change, and repeat the process.
Authorization Manager is used to restrict CSRs from replicating orders.
The following orders cannot be replicated:
• Orders with Add / Change / Delete of Subscriber
• Orders with Changes or Deletes of Persisted Services
• Migration Orders
• Reprovisioning Orders
• Orders with Services that have Named Query Entity Keys
97
• Orders with Suspend / Resumes

• Orders containing the addition of a new address
• Orders containing the addition of a new contact
• Snapshot orders
• Orders with Composed Event based services
SPM Web only displays the Replicate option if the order contains items that can be replicated.
The Replicate option is available at the following locations within the interface:
• Order ID window
• Order Details window
To replicate orders in a batch, perform the following steps:
name).
4 Select the Replicate option from its location, either from the Order ID window or Order Details
window.
The current record is re-displayed to go through the process of adding a new order with the
required changed parameters.
5 Click the service that you wish to order again in the left pane.
6 Modify the parameters of the service.
7 Modify all the required parameters for the new order, then click Next until the shopping cart
appears.
The Order Submitted window appears with the ID of the new order and the same Batch ID.
9 Continue replicating orders as required, then submit the batch.
Impacts from replicating orders include:
• The ownership of the order will not be copied; if the new order is part of a batch, then the
ownership will be set to the owner of the batch.
• Replicated orders may be held by setting a start date, or they may be submitted immediately
for processing.
• If the Replicate option is not available, contact the administrator to set the right privileges.
98
Adding Orders to a Batch
CSRs can create a batch, then add orders to the batch by replicating orders or by adding new orders.
To add an order to the batch, perform the following steps:
2 Click Batch, then search the batch using the Batch ID created in Sigma Provisioning. An existing
batch must contain at least one order.
The batch is displayed.
3 Click Add Order to add a new order to the batch.
The service wizard appears. It allows capturing the new order details in sequence.
Managing Services
• Adding Orderable Services to a Residential Subscriber
• Adding Orderable Services to a Business Subscriber
• Adding Voice Services
• Adding on Demand or Event-Based Services
• Submitting an Order from the Shopping Cart
• Adding Voice Mail or Feature Packages for a Subscriber
• Swapping a Cable Modem or MTA
• Suspending and Deleting Services
• Resetting a Voice Mail Password
• Searching for Selective Services
• Loading Selective Services
• Searching for and Loading Associated Services
Adding Orderable Services to a Residential Subscriber
The Sigma Web interface is configured to handle HSD services, equipment, voice services, video on
demand and wireless services.
In specific cases, equipment (such as cable modems) may be handled by a system other than Sigma.
The service wizard will guide you through the steps to add service. Simply enter the required
information in the windows provided by the service entry wizard and click Next to move to the next
step.
Based on the orderable services you select for the subscriber, a service wizard will display all the
windows required for entry, in sequence.
You may add HSD services, Voice Lines, Voicemail, etc.
• Switch Dial Tone Access
• Call Features
99
• Voice Mail
• Virtual Line
To add orderable services to the residential subscriber, perform the following steps:
name).
4 Click the Add/Edit hot link, then click Services. The Add Orderable Services window appears on
the screen.
5 In the Add Orderable Services window listing all services available to residential subscribers,
enter the desired quantities for the relevant services.
The information pane displays the following columns:
• Service Name: Lists the orderable services available to the subscriber
Note: The service list is configurable and it depends on your implementation and business
practices. You will see only services that apply in this implementation.
• In Profile: Displays the number of services that the subscriber currently holds
• Min and Max columns: Display the minimum and maximum number of allowable services
plans
100
6 Enter the desired quantity (for example, “1” for High Speed), then click Next.
Note: If the services are mutually exclusive, the appropriate message appears.
The Service Wizard displays the relevant sequence of windows for capturing all the required
information.
7 Enter the desired quantity of primary and secondary emails, and webspace.
The Quantity field is unavailable if the subscriber already has the maximum number of services.
8 Click Next to continue, or Reset to clear the fields.
The service is added to the left navigation pane. The star symbol next to the service name in the
left pane indicates that more data is required for the service. The wizard will take you through a
sequence of windows.
9 Enter HSD Access information.

Note: The access information that needs to be captured is configured based on your business
rules. Therefore, in your implementation, you may need to follow a slightly different procedure for
entering access information.
10 Enter mandatory information, such as the Cable Modem MAC address, and any optional
information such as manufacturer, model, etc.
11 Click Next to save the HSD Access information and proceed with computer information.
101
12 Enter CPE information for the primary address, including the required information for the primary
computer:
• CPU
• RAM
• Disk size, etc.
13 Click Next.
The next window is displayed to allow editing the primary email information.
14 Enter the required information for the primary login:
a. Enter the number of primary emails.
b. Enter the number of Web hosting services for the primary login.
15 Click Next to enter primary email information for the primary login.
16 Enter the required information for the primary email:
a. Accept or modify the email ID
b. Enter and confirm password
c. Specify quotas
d. Enter a forward email, if applicable, and the forward start and end dates
e. Click the Wild-card support, if required
17 Click Next. If Web hosting has been requested, the relevant windows are displayed.
18 Enter the disk quota for the web hosting service, then click Next to enter secondary login
information.
19 Enter the number of emails or Web hosting services for secondary login, or leave blank, then click
Next.
20 Enter the required information for the secondary email:
a. Enter a unique email ID
b. Enter and confirm password
c. Enter a forward email, if applicable, and the forward start and end dates
d. Select the Wild-card support check box, if required
21 Click Next. The next window allows editing the Web space information.
22 Select the email to alias the Web space to, then click Next.
Note: Once all the details for the Internet service have been added, you may submit the order. If
the subscriber has requested other services, such as a voice line, you may continue capturing the
order.
23 Enter a primary user and one or more secondary users for the services defined. The respective
users will have access privileges as defined here.
a. Select primary and secondary users for the service as required.
b. Enter details for the primary user.
c. Enter details for the secondary user(s).
When all the details of the services requested have been entered and the user privileges defined,
the shopping cart page is displayed.
102
Adding Orderable Services to a Business Subscriber
Sigma’s SPM Web is configured to handle HSD services, equipment, voice services, video on
demand and wireless services.
In specific cases, equipment such as cable modems may be handled by a system other than Sigma.
The service wizard will guide you through the steps to add orderable service. Simply enter the
required information in the windows provided by the service entry wizard and click Next to move to
the next step.
Based on the orderable services you select for the subscriber, a service wizard displays all the
windows required for entry, in sequence.
You may add HSD services, Voice Lines, Voicemail, etc.
• Switch Dial Tone Access
• Call Features
• Voice Mail
• Virtual Line
To add orderable services to the business subscriber, perform the following steps:
name).
3 Select the business subscriber by clicking the subscriber account number.
4 Click the Add/Edit hot link, then click Services. The Add Orderable Services window appears.
5 In the Add Orderable Services window listing all services available to business subscribers, enter
the desired quantities for the relevant services.
The information pane displays the following columns:
• Service Name: Lists the orderable services available to the subscriber
Note: The service list is configurable and it depends on your implementation and business
practices. You will see only services that apply in this implementation.
• In Profile: Displays the number of services that the subscriber currently holds
• Min and Max columns: Display the minimum and maximum number of allowable services
plans
6 Enter the desired quantity (for example, “1”) for User Services, CPE Equipment and Voice
Services, then click Next.
The Service Wizard displays the relevant sequence of windows for capturing all the required
information.
The Edit Composed Service Users Services window in the wizard appears. It allows capturing the
required information.
103
7 Enter the quantity of user service required, then click Next.

Note: If you try to add too many services for larger subscribers, an “Exceeded maximum services
capacity” message appears. Reduce the number of services you are trying to add, submit the
order, then add the additional services.
8 Enter required User Service information.
The Primary Commercial Voice Line window in the wizard appears. It allows capturing the
required information.
9 Enter the quantity of voice services required, then click Next.
10 Enter or select the mandatory information, such as:
a. Telephone Number: The 10-digit format is validated against the ranges available to your
business unit. No punctuation or spaces are allowed.
b. Port Device Association: Provide entities as required.
When all the details of the services requested have been entered and the user privileges defined,
the Shopping Cart page is displayed.
Adding Voice Services
Service Profile Manager allows you to add voice services to the subscriber profile.
To add a voice line for a subscriber, capture the following data:
• Voiceline Orderable Service (SIP, PacketCable)
• Dialtone
• Features
• Voicemail
To add voice services to the subscriber, perform the following steps:
name).
5 In the Add Orderable Services window listing all services available to business subscribers, enter
the desired quantities for the relevant services.
104
6 Enter the type and number of services that you wish to add for the subscriber in the Add
Orderable Services window. For example, Service Name: Voice Line; Quantity: 1.
Depending on your implementation, this window may offer multiple service options or just voice
options.
The Edit Service Dial Tone window in the wizard allows capturing the required dial tone
information. Access Data to be captured are different depending on the voice technology and on
your specific implementation.
7 Enter or select information such as:
a. Telephone Number: The 10-digit format is validated against the ranges available to your
business unit. No punctuation or spaces allowed.
b. Accept or overwrite the default Call Display Name as desired.
c. Select the LNP Porting Status: “Ported In” or “Not Ported” to flag the service as an incoming
ported number. If “Ported In”, a flag is placed on the telephone number. It will be passed to the
adapters and all the call management servers (for example, Syion or Safari View).
Note: Line Number Portability is possible within the same exchange or between two different
exchanges, but within specific number ranges only.
d. Enter the InterExchange PIC.
e. Enter password.
f. Capture PacketCable voice services, MTA information such as MAC Address, Voice Port
Number, etc. when adding the first voice line.
105
If the phone number format entered is not valid, the appropriate message appears upon
clicking Next.
8 Scroll down and select the calling features for the service.
9 Click each feature that the subscriber wishes to add to the phone line, then click Next.
The Voicemail (add) window appears.
10 Enter voicemail information such as voicemail number.
11 Click Next.
The wizard displays the relevant window based on services requested.
12 Add virtual lines, depending on the voice service requested.
Note: The virtual line is a service for residential and small business use that allows a single party
line to have up to four separate telephone numbers; a primary number and up to three secondary
numbers. A virtual line is a second, third, or forth telephone number on a primary line. Incoming
calls are identified by a distinctive ringing cadence. Outgoing calls are charged to the main
number.
13 Add any secondary voice mails, etc.
14 Click Next.
When the order capture is complete, the Shopping Cart page is displayed.
Adding on Demand or Event‐Based Services
Sigma Provisioning supports one-time event-based services that are not kept in the subscriber
profile. These services have high transaction rates. However, since the entire subscriber profile is not
loaded, high performance is ensured for processing those services.
Sigma's Service Management Platform accommodates customers' need to support provisioning
events for such services.
The service definition capabilities provided by Sigma enable the operator to clearly tag the services
that are one-time and instantiate a workflow process. Subnetwork information may be added to the
respective order for diagnostic purposes.
If one-time service definitions have been configured for your implementation, you may use the Sigma
Web interface to enter those services.
To add on-demand or event-based services, perform the following steps:
name).
5 Enter the type and number of services that you wish to add for the subscriber on the Add
Orderable Services window. For example, Service Name: Voice Line; Quantity: 1.
106
6 Enter the valid information in the following fields:

• Telephone Number: for example, 7093681000
• Switch ID: for example, STJHNF01
• Intercept Type: for example, PODN
This information depends on your business rules and the way the product is configured for you
7 Click Next.
The Shopping Cart is displayed.
Submitting an Order from the Shopping Cart
The Shopping Cart is a utility that allows users to review and modify the service request before
submitting it. Once all the steps for the service request have been completed, the Shopping Cart lists
all the items requested, and the relevant action for each item:
• In Cart shows the content of the cart
• Action is the activity that is being performed on the content, for example, add, modify, delete, etc.
• Remove From Cart allows selected items to be removed from the cart
The Shopping Cart presents the cart items in a scrollable table which fits in the window. You can sort
items in the cart with the table presentation.
In this window, you can perform the following activities:
• Enter order header parameters
• Schedule or hold an order
• Remove items and update the shopping cart (order) as needed
• Verify the order prior to submitting it
• Clear the cart to discard all the information captured for the order
• Submit the order
Before submitting the cart, update it and verify it as required. You may also clear the cart.
To update the shopping cart, perform the following steps:
name).
4 Click the Add/Edit hot link to update services for the subscriber.
5 In the shopping cart window, select the item(s) that you wish to remove by selecting the check
box next to the item in the Remove From Cart column.
107
Remember that each telephone service must have a feature package. Do not remove mandatory
features from the cart.
6 Click Update Cart to remove the selected items.
The items that have not been selected remain in the order. You may resume the order capture to
add the items removed with the correct information. You may also submit the order directly.
In the Shopping Cart window, you can optionally verify the order before submitting it to ensure
that the correct information has been entered.
To verify an order, perform the following steps:
1 Click Verify Order.
2 If an error is found, click Edit to continue editing the services.
3 Submit the order when a message verifies that no errors have been found.
4 Click Clear Cart to discard the order and remove all items from the cart.
Everything is removed, including the subscriber information.
Once you have added or edited subscriber services, or changed the account status, you may
submit the order from the shopping cart.
To submit a subscriber order, perform the following steps:
1 Complete the order entry wizard. In the Subscriber tab, click View Cart.
2 Capture order header parameters as required.
108
3 Optionally, enter a start date or clear the Hold Order Flag check box to pre-queue the order
(schedule it for a specific date or hold it as required).
4 Click Submit Order to submit the order for execution in the Shopping Cart page. This action also
incorporates a verification check.
Once the order is submitted, an information message shows the order ID for verification
purposes.
If the services have been initiated, the order will have an impact on the network as the
provisioning action takes place.
Adding Voice Mail or Feature Packages for a Subscriber
You can use SPM Web to add a voice mail or feature package for the subscriber at a later time.
To add voice mail or a feature package for the subscriber, perform the following steps:
name).
4 Click the Composed Service Voice Line in Services in the left pane, then enter the desired
quantity for the service to be added.
5 Enter all the required fields for Voice Line service (for example, Telephone Number: 7095454545,
LEN:SSL 00 0 00 33).
6 Follow the steps in the wizard.
If adding a secondary mailbox, you may need to select the Voice Mail Box Position of the
secondary voice mail from the drop-down list. Enter the Associated Email Account and VM
Password. For example, Voice mail Password: abcdef1234
7 Review and click Submit Order in the Shopping Cart page to submit the order.
Swapping a Cable Modem or MTA
When the Sigma application handles integrated services, make sure you update both the Cable
Modem and the MTA, which belong to the same physical device, using the Web interface.
When changing the Cable Modem MAC, you must also change the MTA MAC. In situations where
you need to correct typos in the device information without replacing the device, you can update and
submit the relevant information only (CM or MTA).
When replacing the physical device in the field, the technician has the option of providing the relevant
information to a customer service representative, or updating the information personally if the
technician has access to the system.
To swap a cable modem or MTA, perform the following steps:
name).
109
4 Click HSD Access under Services in the left navigation pane.
5 Replace the value displayed in the Cable Modem MAC Address field with the MAC of the new
device (12 hex digits, the alpha characters in lower or upper case, no punctuation between the
digits).
6 Change all the related information such as Cable Modem Serial Number, etc., for the replacement
modem. Do not modify the Quality of Service.
7 If different than the previous one, select the Manufacturer from the list.
8 Select the Model from the list of models provided by the selected manufacturer.
9 Click Next.
The Shopping Cart window shows the updated item.
Depending on your equipment configuration, you may need to change the MTA MAC as well. In
this case, make the change on the MTA for the voice service first and then submit the cart.
10 Submit the order in the Shopping Cart.
Upon completion of the order, the new device is activated.
When the Sigma application is configured to handle specific services only (for example, voice),
you must update the cable information in the external system where it is handled before updating
the dependent MTA.
110
The high-level steps of this process are the following:

a. Swap the MTA using the Sigma interface
b. Swap the Cable Modem using the third-party system
c. Coordinate the activities above
Suspending and Deleting Services
You can use SPM Web to suspend, delete and resume services from a subscriber’s profile. To do this,
you must submit a “change status” action against the service.
To suspend or delete services, perform the following steps:
name).
3 Select the subscriber by clicking the subscriber account number and clicking Actions.
If a specific service has not been selected, a message prompts you to select a service. If there is
a pending order for the subscriber, an error message appears.
Do not delete or suspend the MTA.
4 Select the service to be suspended or deleted (for example, a voice line).
The Change Service Status window lists the services that are affected by the status change.
5 In the Change to field, select the appropriate action. Services may be deleted or suspended for
abuse (for example, MSO Block for suspended).
111
In this case, select Delete in the Change to field.

6 In the Reason Code field, select a reason from the drop-down menu (required) (for example,
select “Abuse” in the case of an MSO Block).
7 In the Reason Message field, provide a brief description of the reason for the service status
change (optional).
8 Click Update Cart and confirm the action at the prompt.
Resetting a Voice Mail Password
If the subscriber forgets the voice mail password, you may reset it using the Web interface.
To reset the voice mail password, perform the following steps:
name).
4 Select Primary Mailbox in Services in the left pane.
The Edit Primary Mailbox window appears.
5 Enter and confirm the initial email password, communicate it to the subscriber, then click Next.
Note: In some implementations, the initial password may be pre-configured, for example, to the
last 4 digits of the telephone number entered. In that case, if you check the Reset password
option, the default value is saved and you must communicate it to the subscriber.
6 In the Shopping Cart window, click Submit Order.
Once the order it is completed, the subscriber can change the default VM password to a chosen
password.
Searching for Selective Services
To search for selective services, perform the following steps:
2 Search for the subscriber as mentioned in the Searching for a Large Subscriber section.
There are different search pages for all the orderable composed services, like Users, CPE
Equipment, Voice Services and Voice Groups.
4 Click the Composed service to see the respective search page.
The Search page provides different search criteria. Different search parameters can be used to
load the required service.
112
For example:
• For CPE Equipment service, the search parameters are: Device Type, Device Name, MAC
Address, and Telephone Number
• For Service Users, the search parameters are: First Name, Last Name, Admin Type,
Department, and Telephone number
• For Voice Services, the search parameters are: Telephone Number, and department
• For Voice Group, the Search page displays the list of voice groups like Hunt Group, Call
Pickup Group, and Call Park group. Once you select a Group and click the Next button, the
Search page for corresponding Group appears. The search parameters can be: Switch Id,
Group Name, Pilot/Member.
The parameters displayed on the search page can vary depending on the project implementation.
5 Enter the relevant information, then click Search.
The list of services matching the search criteria appear in the search page.
Loading Selective Services
You can use SPM Web to select and load multiple services across multiple pages.
To load selective services, perform the following steps:
2 Search the subscriber as mentioned in the Searching for a Large Subscriber section.
4 Select the desired services. You can select one or more services at a time. If the matching
services count is large, then the record appears across multiple pages.
5 Click Next.
The View Service page appears.
113
In addition, all the selected services are loaded. You can view these services in the left pane.
Searching for and Loading Associated Services
When services are loaded for large subscriber, the associated services must be loaded separately.
To search and load associated services, perform the following steps:
2 Search for the large subscriber as mentioned in the Searching for a Large Subscriber section.
3 Click the desired subscriber.
4 Load the reference services, then load dependent services. For example, to load the voice group,
first load the voice lines which are the members of those groups. Only you can see the respective
voice lines in the voice groups assigned member or unassigned member list in the Voice Group
Page.
5 Search the reference services, then load the services as mentioned in the Loading Selective
Services section.
6 In the Dependent Services search page, select the Associated service.
7 Click Next.
In case the check boxes are not provided, you can select multiple services using the Shift + Click
and CTRL + Click key combination if these search pages are customized.
Search Pages may let you load associated services without performing any manual steps.
However, it depends on how these search pages are customized to handle it in your project
implementation.
114
Executing Manual Tasks
The Manual Queue Manager is used to manually intervene in the order processing by manually
completing tasks that otherwise cannot be completed.
In your implementation, there may be steps or tasks that are not automated (such as a test loop)
when there is no adapter to communicate with the external process, or if specific communication
protocols are not defined.
The Manual Task Search tab in the Web interface provides access to the manual queue tool, allowing
users to execute specific tasks manually.
Manual tasks can be assigned to different groups of users as defined by the administrator. Users can
view and execute manual tasks for which they are authorized, or which are not assigned to any other
user. The Manual Task Search tab displays only those tasks that the user is authorized to view.
SuperUsers and NormalUsers have been defined as the types of users for the manual task feature.
Your business rules determine what privileges users need to execute manual tasks from the Web
interface.
Sigma provides a Workflow Console to execute manual tasks. The same functionality may be
implemented through the Web interface. When you update the task in the Web interface, it
automatically updates in the Workflow Manager, and vice versa.
To execute a manual task, perform the following steps:
2 In the SPM UI, click the Manual Task Search tab.
A list of tasks requiring manual intervention appears.

3 If the task has not yet been assigned to you, take ownership of it.
Depending on your configuration, some of the fields will open for editing.
4 Highlight the parameter that you wish to change and change the value in the field provided at the
bottom of the window.
5 Click Submit to execute the order.
A confirmation message is displayed.
6 Click Refresh.
The order is no longer listed in the Manual Task Search tab.
115
The Manual Queue UI provides the Manual Queue Notes which now persist for the lifetime of an
order. It provides the Order Notes link in the Sigma Provisioning Web for linking to the Order Notes
screen for the Order Notes Search page.
There are two types of notes:
• Order Notes for all the Manual Tasks for given order
• Task Notes for the selected Manual Task
The Manual Queue UI shows the Notes associated with the current Manual Task as well as all the
Notes associated with the order.
The Manual Queue UI uses the platform Named Queries to search the Manual Task list for given
search criteria, such as Order ID, Parameter Name Value, etc.
To view manual task notes, perform the following steps:
2 Click the Manual Task Search tab.
A Search Task window appears.
3 Enter the required Task details.
4 Click Submit.
A list of tasks requiring manual intervention appears.
5 Select the Manual Task from the left pane, then click the Notes tab.
A Task Notes window appears.
6 In the Notes tab, click Order Notes.
A Task Notes For Order window appears in the right pane. You can view the aggregated Manual
Task notes associated with that Sigma Provisioning Order ID in the right pane. Use the horizontal
scroll bar to view the information:
• Owner: Displays the owner of the manual task notes
• Created Date: Displays the date when the manual task note was created
• Note Message: Displays the message related to that note
You can also view the Manual Task Notes in the View Order Details page.
To view the manual task notes on the View Order Details page, perform the following steps:
1 In the SPM UI, in the Orders tab, click View.
The Orders Details window appears.
The Order Details page displays the Manual Task Notes option if there is Manual Task Notes for a
given Order. Otherwise, the option does not appear in the Order Details Page.
2 Click Manual Task Notes.
Notes for selected orders appears.
116
To customize the manual task details view, perform the following steps:
1 Develop a customize view configuration.
For example:
<flow‐handler>
<handler‐result result="ok"
screen="MANUAL_TASK_PARM_LIST"/>
<handler‐result result="ok.taskWithRequiredInArgs"
screen="MT_PARM_LIST_VIEW_ONE"/>
<handler‐result result="ok.m_va_update_cm"
screen="MT_PARM_LIST_VIEW_TWO"/>
</flow‐handler>
2 In request mapping, associate the customized result screen with the given flow handler.
The Task Type TaskWithRequiredInArgs has the mapping in the above sample configuration. It
loads the MT_PARM_LIST_VIEW_ONE as the customized view.
117
Running Migrations
Service Migrations are used to move a subscriber from one service package to another without
having to disconnect their current services.
For example, a subscriber can move from a Regular Internet package to a Pro Internet package and
vice versa, or from an Internet Package to an Internet and Voice package, etc.
The migrations required in your implementation are configured using the Service Creation Toolkit.
When migrating from one package to another, the webspace, email space, and number of secondary
emails may differ. Also, the pro package includes self care access.
Rather than deleting one package and then submitting an order for the desired package, a migration
has been mapped and configured. While in progress, the service is not interrupted. When the
migration order is submitted, the parameters for webspace and email space are modified
appropriately.
Migrations configured as executable in an implementation are listed as options in the Migrations
window when a service is selected.
To run the migration, perform the following steps:
2 In the SPM UI, search for the subscriber whose services you wish to migrate.
3 In the Subscriber tab, click Migration.
118
4 Select the service to migrate in the left pane.

5 Select the required migration, then click Next.
The shopping cart window lists all the updates required by the migration.
Once the order is submitted, all the updates, additions, and deletions predefined for the migration
will be executed.
To run the migration with other methods, perform the following steps:
1 In the Subscriber tab, click the Migration link.
2 Select the service to migrate in the left pane. For example, the Internet Pro package.
3 Select the required migration from the available migrations, then click Next.
The shopping cart window lists all the updates required by the migration.
Once the order is submitted, all the updates, additions, and deletions predefined for the migration
will be executed.
Service To Resource Mapping
• Adding Service to a Resource Map Definition
• Deleting Service from a Resource Map Definition
• Adding Regional Event Definition
• Deleting Regional Event Definition
Adding Service to a Resource Map Definition
The Service to Resource Configuration is used for managing services, resources, PPV events, and
for the network provisioning of those services.
Authorization Manager controls the user’s access to the tab.
The Service to Resource Configuration functionality is available to the user through the Service
Profile Manager UI.
The Service to Resource Configuration tab in Service Profile Manager UI provides the following
functionality:
• Service Configuration
• Network Resource Configuration
• Service to Resource Map Configuration
• PPV Events
If a row of data has been added or edited, it remains in the local cache until the user commits the
change.
Before adding service to a resource map definition, ensure that the MSO Administrator adds a new
service offering. At MSO, Sigma Provisioning provides service to resource mapping.
119
To add service to a resource map definition, perform the following steps:

2 Add the regional service definition in SPM Web.
To add a new service, enter the information such as Service type, Service Code, Service
Description, and Expiry date.
The data is entered into the “Regional Service” table in the Sigma Provisioning topology.
3 Add Network Resource Definition in SPM Web.
To add a new resource, enter the resource code in the Resource Code field.
4 Enter the resource description in Resource Description field.
The data is entered into the “Network Resource” table in Sigma Provisioning topology.
5 Add Service to Resource Mapping Definition in SPM Web.
To create a map for a specified regional subnetwork:
a. Select a regional subnetwork type. The regional subnetwork type could be:
Conditional_access_server, Vod_server, Video_zone, Channel_lineup, Root.
b. Enter Map Name and Description.
The data is entered into the “Service To Resource Map” table in Sigma Provisioning topology.
Deleting Service from a Resource Map Definition
In deployments where Sigma Provisioning supports decomposing a video subscription service (a
service ID that is understood by the business, such as “Family Package”) into a set of resources that
are fulfilled on the network to deliver the service offering, Sigma Provisioning has to support
management of this service to resource mapping definition. Deletion of the regional service and
service to resource map does not result in Sigma Provisioning re-provisioning of existing subscribers
with video subscription for the deleted regional service ID.
Before deleting a service to resource map definition, ensure that the service to resource mapping
definition is available in Sigma Provisioning topology.
To delete service from a resource map definition, perform the following steps:
1 In SPM Web, select the service to resource map entity to be deleted.
2 Click Delete.
The data is entered into the “Service To Resource Map” table in Sigma Provisioning topology.
Adding Regional Event Definition
In deployments where Sigma Provisioning supports decomposing a video subscription service (a
service ID that is understood by the business, such as “Family Package”) into a set of resources that
are fulfilled on the network to deliver the service offering, Sigma Provisioning has to support
management of this service to resource mapping definition.
In these deployments, Sigma Provisioning must also support decomposing a PPV event service into
the resource tag recognized by the network that delivers the PPV event.
Before adding regional event definition, ensure that the MSO Administrator needs to add a new PPV
event service offering. For MSO, Sigma Provisioning provides service to resource mapping.
120
To add a regional event definition, perform the following steps:

2 Add a regional event definition in SPM.
To add a new PPV event, enter information such as Event Code, Service Delivery Platform, Event
Description, Resource Tag, Start Date, and End Date.
The data is entered into the “Regional Event” table in Sigma Provisioning topology.
Deleting Regional Event Definition
This task describes how the digital provider retires a new PPV event service offering (before the
expiry date) and deletes the regional event definition in Sigma Provisioning topology using the SPM
GUI.
Before deleting regional event definition, ensure that the regional event mapping definition is
available in Sigma Provisioning topology
To delete a regional event definition, perform the following steps:
2 Click the Svc_Rsrc_Cfg tab in the SPM GUI.
3 Click the PPV Events tab.
4 Select the desired PPV event row, then click Delete.
Using Network Query
The Network Query tab is visible only when the Project Implementation uses the Nortel Switch for
Voice services. The Network Query provides a simple way to query for Telephone Number (dn -
Directory number) and LEN (line equipment number) in place of using the Nortel command. This
interface sends the command to the switch for query.
This interface searches the dn or len entered by the user for selected switches only.
To use network query, perform the following steps:
2 In SPM Web, click the Network Query tab.
3 Select the option for query, which can be dn, len or qsip.
4 Select a switch on which the query is to be executed.
5 Enter the telephone number or len value as input for query.
A new window shows the switch response and indicates if the entered tn or len is assigned or
unassigned.
121
Defining a New Query Type
You can use the SCT to configure queries for an implementation. The reserved queries are required
by the back-end to function correctly and should not be altered. Each named query belongs to a
query type. Before defining a new query, the user must decide to which query type the new query
belong. If a new query type is required, the user must define it before adding queries to it.
The following query types are pre-defined in the SCT:
• order
• batchorder
• wfinst
Do not change these types. You can define new types. Before adding a new query type, ensure that
SCT is installed on your computer.
To define a new query type, perform the following steps:
1 Launch the SCT.
2 Open an existing implementation.
3 In the left navigation pane, click Named Queries.
The current list of query types is displayed in the content pane.
4 In the content pane, click the Add icon.
The Query Type dialog box is displayed.
5 Enter the required information in the Query Type dialog box, then click Ok.
The new query type is added to the list.
Accessing Access Control from SPM Web
• Fine Grained Authorization
• Authorization Manager (AM)
Fine Grained Authorization
The Access Control tab in the SPM Web is used by administrators to manage fine grained
authorization for Sigma Provisioning applications.
The Sigma A&A component provides a common authentication service. However, user permissions
(authorizations) are managed within the Sigma Provisioning applications in a very similar manner to
previous versions of the platform.
The diagram below shows the authentication and authorization model used in Sigma Provisioning
6.2.
122
• Sigma A&A manages users and groups in its own AA schema (Oracle storage). For AD
integration, the user/group will be managed in the AD server.
• The AM module in Sigma Provisioning manages Group, Resources and ACL in the AM schema
(the same schema as Sigma Provisioning 5.x AM).
• Sigma Provisioning will also have a group mapper plugin, which maps A&A groups to Sigma
Provisioning groups. By default, it is passthrough.
During runtime, a Sigma Provisioning user is authenticated with Sigma A&A. Sigma A&A validates
the user credentials and returns the subject with the group list. AM invokes the group mapper to
enrich the subject, as needed. The default group mapper does a passthrough, assuming the groups
in A&A match the groups in Sigma Provisioning AM. The AM module performs authorization based on
the enriched group list against the configured ACLs.
Implementation teams may define a custom group mapper based on A&A integration on the customer
site (for example map AD group to Sigma Provisioning group for AD integration).
Authorization Manager (AM)
Authorization Manager (AM) is a central module within Sigma Provisioning that controls user access
to all other components, including the Service Profile Manager Web interface, the Topology Manager,
and the Service Creation Toolkit. It handles permissions and access rights for the Sigma Platform and
applications.
All of the user information handled by AM is stored in the Authorization Manager's database (which is
provided separately for the sake of security). AM interacts with external user profile systems through
a predefined Java Application Programming Interface (API).
AM provides a web interface and allows users to perform the folllowing tasks:
• Create groups
• Grant or revoke user access rights to different Sigma Provisioning components and
subcomponents (resources), and to the Reports utility based on group privileges.
123
AM also acts as a system-wide filter. When a user makes a request from any of the Sigma UIs, AM is
queried by the relevant component and determines how the request should be handled. For example,
if a user navigates to a screen where subscriber data is displayed, the web interface will make a
request to AM before displaying the screen to the user. AM determines what parameters can be
viewed based on the user's security or access level, and responds back to the SPM Web with a form
containing only the resources the user is entitled to see.
Note: If the previous validations are met, but the group the user belongs to does not have access
privileges to the respective module, then either the user cannot view the respective module, or is
notified that their privileges are insufficient.
Concepts
Authentication
AM assumes the application has authenticated against an external IPD (like Sigma A&A) and has
access to user with group memberships.
Authorization
AM allows users to control access to resources or data. Access can be restricted based on criteria
such as group and request parameters. To authorize users, AM verifies a user's right to access, read,
modify, insert, or delete data and available resources, execute certain programs or activities, or to
receive and disseminate specific data.
Groups
You can create new groups to classify different user roles, such as supervisors and CSRs. Groups
are defined by the access privileges granted to them. For example, a CSR group can be created and
assigned the privileges of adding, editing, or deleting subscriber information and access to diagnostic
tests. Group names and descriptions are stored in the GRP table.
It is possible for a user to be a member of more than one group. It is also possible for a group to be a
member of another group. For example, Group A can be a member of Group B, however, loops are
not permitted (that is, if Group A is a member of Group B, then Group B cannot be a member of
Group A).
Once the groups are created, you can define privileges for them, that is, access rights to available
resources, such as applications and objects.
You can assign pre-defined parameters to particular groups to control the information displayed to the
user upon login. These parameters are pre-defined for each implementation. For example, you can
set a language parameter to French so that when the user logs in to a Service Management Platform
application, the interface language is displayed in French.
Several groups can form one Supergroup.
Privileges
Privileges are access rights set up at the group level. They allow specific groups to have access rights
to specific resources. For example, the group "CSR Supervisor" has permission to log in, search,
execute, view definitions, or view the history of an object. To grant privileges, you must assign
124
permissions to a specific user group for a specific resource. For example, for the CSR Supervisor
user group, assign view-only permissions to Service Profile Manager.
You can give permission by assigning permissions to a group. An exception to this occurs when
groups are sub-groups of other groups and you do not want to assign the same permissions to the
sub-group as to the main group. In this case, you have to revoke permissions that are automatically
inherited by the sub-group. For example, if Group B is a subgroup of Group A, and you grant a
permission to Group A, normally Group B would be granted the same permission as well. But if you
want to give permission to only Group A, you should revoke the permission for Group B.
User groups are granted different access privileges to resources depending on their roles and
business requirements. Different groups can have different access rights to the same object. For
example, in Service Profile Manager, Group A may have access to subscribers and services,
whereas Group B may have access to subscribers, services, and diagnostics.
The privileges to which a group is entitled to are stored in the ACCESS_CTRL_ENTRY table of the
AM database.
Note: See Appendix: Authorization Manager Privilege Matrices for more information about AM
Privilege Matrices.
Resources
Resources are the entities in your environment that require protection, such as applications, menus,
and objects. Before you can grant privileges to access resources, create a reference list of the
available resources.
Note: This guide does not provide lists of resources (neither generic nor customized). You need to
familiarize yourself with the list of resources specific to your implementation.
Permissions
Permissions are access rights set at the resource level (for example, applications and objects).
Before granting group privileges to access available resources, you must assign permissions from a
reference list.
Permissions refer to the actions that a user can perform on a specific resource (for example, logging
on to an interface). Users can be granted permission to add, update or view data.
When assigning privileges, remember that some resources have a hierarchical structure in which the
parent resource has sub-resources, or child resources. This relationship is expressed using dot
notation.
The child resources automatically inherit the access privileges granted to the parent (that is, initially
they all have print, read, and write permissions). Those permissions change when new permissions
are specified for each child resource.
Tips
The following tips need to be kept in mind as you use AM:
• Ensure that the resource name is correct. AM does not verify the newly created resources.
• "Revoke permission" overrides the "grant permission". This means that if a user is a member of
two different groups, one that can view a certain menu, and another that cannot, the user will not
be able to view the menu.
125
• If a required resource is not already loaded in AM, check the naming convention with Sigma
Support.
• In order to use the "smp.manualqueue.{name}" resources, the implementation should define
groups with "view" and "edit" permissions for this resource and add relevant users to those
groups.
Managing Groups
This section contains the following instructions on how to manage Sigma Provisioning groups using
the Authorization Manager too (Access Control tab):
• Adding a Group
• Searching for a Group
• Editing Group Information
• Deleting Groups
• Reporting Group Membership
Adding a Group
To add a group to the AM database, perform the following steps:
1 Log on to the SPM Web UI.
2 Click on the Access Control tab.
3 From the Access Control tab, select Groups. The Search Group page opens.
4 From the left pane menu, click Add Group. The Add Group Information page opens.
126
5 Enter a new Group Name (for example: csr_sup). The group name must be less than 30
characters in length.
6 Enter the Group Description (for example: csr supervisor). The group description must be less
than 255 characters in length.
7 Optionally, from the drop-down list, select the Service Provider ID.
8 Optionally, from the drop-down list, select the Service Provider ID For New Subscribers.
9 Optionally, from the drop-down list, select the Admin Resource Name.
Note: If you have entered the wrong information, click Reset, and then click Add Group to start
the process over again.
10 Optionally, to add this group to another group, select the group from the Available Groups list,
then click the right arrow (>) to move the group to the Member of following groups list. The new
group is now a member of that group.
To remove a group from a group, select the group from the Member of following groups list, then
click the left arrow (<) to move the group to the Available Groups list. The group is no longer a
member of that group.
Note: If you do not assign Admin Resources or add this group to another group (steps 6 and 7
above), then you must go to the Privileges page before you can use the newly activated group.
Refer to the Managing Resources, Privileges, and Permissions section for more information.
11 Select a resource name from the Resource Name drop-down list.
12 Select a permission from the Permission Name drop-down list.
13 Optionally, check the Revoked check box (if applicable).
14 From the Parameter Name drop-down list, select a parameter.
15 Optionally, in the Parameter Value field, enter a value.
16 Click Submit.
The new group has now been added to the database. You can edit or delete the group’s information.
Searching for a Group
To search for any existing group in the system, perform the following steps:
1 Log on to the SPM Web UI and click the Access Control tab.
2 Select Groups from the menu on the left of the UI. The Search Group page opens.
127
3 Enter the Group Name (for example: *csr).

Note: Wildcard searches are allowed. Enter an asterisk (*) to replace any number of characters of
any value. If you replace the entire group name with a wildcard, you will retrieve all the groups in
the database. In this case the wildcard *csr was used.
4 Click Find Group. If you have made a mistake, click Reset and then enter the correct information
again.
If more than one group is found, the Search Results page opens, displaying a list of all groups
that match your search criteria. Otherwise, the View Group Information page opens.
The Search Results list has several columns containing information associated with each group.
Column Name Description
Group Name The unique group name. For example: csr.
Group Description The unique description of the group. For example: CSR supervisor.
Created Date The date the group’s information was created (entered).
Parent Group Names The supergroup to which the group belongs. For example: the Supervisors
group may belong to the CSR’s parent group.
5 If you do not see the group that you are looking for, click Search Group to perform another search
using different criteria.
6 Select a group from the Search Results list. In this example, the csr group is selected.
128
The View Group Information page is displayed.
Editing Group Information
You can modify group information as required by circumstances. For example, you can remove a
group from another group, and then add it to a separate group. You can also change incorrect group
information, if required.
To edit group information, perform the following steps:
129
3 Enter the Group Name, or enter an asterisk (*) to perform a wildcard search.
4 From the Search Results page, select a group.
5 From the left navigation pane, click Edit Group. The Edit Group Information page opens.
6 On this page, you can edit the group's information, as required.

Note: If you have edited the wrong information, click Reset, and then click Edit Group to start the
process over again.
7 Add the group to another group, or remove them from another group.
a. From the Available Groups list, select the appropriate group, then click the right arrow (>) to
move the group to the Member of following groups list.
b. From the Member of following groups list, select the group, then click the left arrow (<) to
move the group to the Available Groups list.
8 Click Submit.
The group information has now been edited successfully.
130
Deleting Groups
Deleting a group ensures that members of this group no longer have access privileges to log on to a
specific component.
To delete a group, perform the following steps:
3 Enter the Group Name, or enter an asterisk (*) to perform a wildcard search.
4 From the Search Results page, click on a group.
5 In the left navigation pane, click on Delete Group. The Delete Group Information page opens.
Note: You will be unable to delete a group if it has users attached.
131
6 Ensure that the correct group is displayed on the screen.

Note: If the incorrect group is displayed, click Reset, and then click Delete Group to start the
process over again.
7 Click Delete to delete the group.
The group will now be deleted.
Reporting Group Membership
Access to the Reporting tab requires the authentication of the user against AM. There is an implicit
authentication when the user clicks on the reporting tab. Features within the reporting application are
also separately authorized (for example, normal users can only view/execute reports). Power users
can create new reports, and delete/modify existing ones. Administrators have permissions to do
everything.
Access control is modeled as roles within the Reporting application, and groups from AM are mapped
to these roles. This mapping is part of configuration and cannot be changed at runtime. Thus, Sigma
Provisioning AM users can be assigned specific roles within Jasper by modifying their group
memberships from the AM Web.
The SMP Auth groups are mapped as follows:
<property name= "authMgrGrpRoleMapping" >
<props>
<prop key= "csr" >ROLE_USER</prop>
<prop key= "csr_supervisor" >ROLE_USER</prop>
<prop key= "csr_admin" >ROLE_ADMINISTRATOR</prop>
</props>
</property>
132
Managing Resources, Privileges, and Permissions
This section contains instructions for managing Sigma Provisioning resources, privileges, and
permissions using the Access Control tab on the SPM Web UI. It also contains information about the
related concepts.
• Managing Resources
• Managing Privileges
• Permissions
Managing Resources
Resources are the entities within your environment that require protections, such as applications and
objects.
Prerequisites
• Before you grant privileges to access resources, you must create a reference list of all available
resources.
• Before you create or grant privileges, you must add resources to the Authorization Manager code
and database.
• Users defining the reference list of resources must have a good understanding of their
implementation, as well as Sigma products. For example, users defining resources for network
management purposes must have a good understanding of their network topology, and all the
resources associated to the respective topology.
• Users defining permissions must have a good understanding of the list of reference resources
defined for the respective application, as well as the permission levels that they wish to grant in
their business context.
Adding a Resource
To add a resource to the AM database, perform the following steps:
2 Click Privileges.
3 From the left pane menu, click Add Resource. The Add Resource Information page opens.
133
4 In the Resource Name field, enter the resource name (for example, STM_create_subntwk). The
resource name must be less than 255 characters in length.
5 In the Resource Description field, enter the resource description for the STM_create_subntwk
resource. The resource description must be less than 255 characters in length.
Note: Users who are granted access to a specific resource will be able to edit, update, lock, or
view this resource, based on the permissions defined for the groups to which they are assigned.
6 Click Submit.
Note: If you have entered the wrong information, click Reset, and then click Add Resource to start
the process again.
The new resource is added. You can now view, edit, or delete the resource information.
Searching for and Viewing a Resource
You can view a description of an existing resource, its date of creation or modification, and the name
of the modifier or the creator.
To search for and view a resource, perform the following steps:
2 Click Privileges.
3 From the left pane menu, click Search Resource. The Search Resource page opens.
4 Enter a resource name in the field provided, or enter an asterisk (*) as a wildcard to display a list
of all the existing resource names in the database.
5 Click Find Resource (or if you have entered the wrong information, click Reset and enter the
correct information again). The Search Results page opens.
134
The Search Results list displays the resource name and description.
Note: If the search result returns more resources than can fit on one page, click Next to view the
next page. Alternatively, click Back to view the previous page.
6 Select a resource from the Search Results list. The View Resource Information page opens.
135
Editing a Resource
You can change some or all of a resource's information. For example, you can change the description
of the resource to make it more explanatory.
To edit a resource, perform the following steps:
1 Once you have searched for and located a resource (see the Searching for and Viewing a
Resource section), click Edit Resource from the left navigation pane. The Edit Resource
Information page opens.
2 Change the Resource Description, as required.

Note: If you have edited the wrong information, click Reset, and then click Edit Resource to start
3 Click Submit.
Deleting a Resource
Deleting a resource from the user interface removes the privilege that allows its use so that it can no
longer be granted. The deleted resource will continue to be present in the AM database (reference list
of resources).
To delete a resource, perform the following steps:
1 Search for and locate the resource you wish to delete (see the Searching for and Viewing a
Resource section).
2 In the left navigation pane, click Delete Resource The Delete Resource Information page opens.
136
3 Ensure that the correct resource is displayed on the screen.

Note: If the incorrect resource is displayed, click Cancel, and then click Delete Resource to start
4 Click Delete.
137
SPM Web UI Available Resources
When you log in to the SPM Web UI with administrator privileges, you can access all of the AM
resources by clicking the Configuration tab.
Visibility Control
An AM resource is used to control the visibility and editability of parameters in the form of a generic
entity. This resource is an extension of the resource used to control visibility of entities in the tree.
Managing Privileges
Privileges are the access rights set up at the group level. They allow specific groups to have access
rights to specific resources. For example, the group "CSRSupervisor" has permission to log on,
search, execute, view definitions, or view the history of an object. You can grant privileges to specific
resources such as applications, or data.
Privileges are specific permissions assigned to user groups to access specific resources. For
example, for the CSR Supervisor user group, you could assign edit permissions to all service
parameters in the Service Profile Manager web interface.
You give permission by assigning a permission to a group (and no other actions are necessary). An
exception occurs when groups are sub-groups of other groups, and you do not want to assign the
same permissions to the sub-group as to the main group. In this case, revoke the permissions
automatically inherited by the sub-group. For example, if Group B is a sub-group of Group A, and you
grant a permission to Group A, normally Group B would be granted the permission as well. But if you
want to give only Group A permission, you must revoke the permission granted to Group B.
User groups are granted different access privileges to resources depending on their roles and the
business requirements in effect. Different groups can have different access rights to the same object.
138
For example, Group A may have access to subscribers and services, whereas Group B may have
access to subscribers, services, or the Admin Tool.
Adding a Privilege
Note: Add privileges to the AM database before you grant them.
To add a privilege to the AM database, perform the following steps:
2 Click Privileges. The Search Privileges page opens.
3 From the left navigation pane, click Add Privilege. The Add Privilege Information page opens.
4 From the Resource Name drop-down list, select the Resource Name (for example, samp.web, or
samp.web.menu, among a list of other options).
139
5 From the Permission Name drop-down list, select the Permission Name that applies (for
example, assign, delete, or edit, among a list of other options). The permission associated to
the resource selected defines the privilege level that you wish to assign to specific users and
groups.
Note: If you have entered the wrong information, click Reset, and then click Add Privilege to start
6 To grant permission to a group, select the desired group from the Available Groups list under the
Groups Granted Permission section, then click the right arrow (>) to move the group to the
Selected groups list.
To remove permission from a group, select the group from the Selected groups list under the
Groups Granted Permission section, then click the left arrow (<) to move the group to the
Available Groups list.
7 To revoke permission from a group, select the desired group from the Available Groups list under
the Groups Revoked Permission section, then click the right arrow (>) to move the group to the
To undo the revoked permission, select the group from the Selected groups list under the Groups
Revoked Permission section, then click the left arrow (<) to move the group to the Available
Groups list.
Note: When you do not want to assign the same permissions to a sub-group as to the main group,
you may revoke those specific permissions from the sub-group, out of all the permissions
inherited from the group.
8 Click Submit.
Searching for and Viewing a Privilege
To search for and view a privilege, perform the following steps:
2 Click Privileges. The Search Privilege page opens.
3 Enter either a resource name, a permission name, or a group name in the field(s) provided.
Wildcard searches are permitted. You can enter an asterisk (*) into a field or partial information
plus an asterisk (for example, *STM). The Search Results page opens.
4 If the search result returns more privileges than can fit on one page, click Next to view the next
page. Alternatively, click Back to view the previous page.
140
The Search Results list has several columns with information associated to each privilege, as
shown in the table below:
Column Name Description
Resource Name A unique name for the resource.
Permission Name A unique name for the permission.
Granted Groups The groups which have been granted the privilege.
Revoked Groups The groups which have not been granted the privilege.
5 Select a privilege from the Search Results list. The View Privilege Information page opens.
Editing a Privilege
You can change some or all the information associated to a privilege. For example, you can change
the group that has been granted or revoked the privilege.
To edit a privilege, perform the following steps:
1 Search for and select a privilege (see the Searching for and Viewing a Privilege section).
2 From the left navigation pane, click Edit Privilege. The Edit Privilege Information page opens.
141
3 To add permission for a group, select a group from the Available Groups list under the Groups
Granted Permission section, then click the right arrow (>) to move the group to the Selected
groups list.
To remove permission from a group, select the group from the Selected groups list under the
Groups Granted Permission section, then click the left arrow (<) to move the group to the
Available Groups list. The group no longer has permission to the privilege.
4 To revoke permission from a group, select the desired group from the Available Groups list under
the Groups Revoked Permission section, then click the right arrow (>) to move the group to the
To undo the revoked permission, select the group from the Selected groups list under the Groups
Revoked Permission section, then click the left arrow (<) to move the group to the Available
Groups list.
Note: If you have edited the wrong information, click Reset, and then click Edit Privilege to start
5 Click Submit.
Deleting a Privilege
You can delete a privilege so that it can no longer be granted.
To delete a privilege, perform the following steps:
1 Search for and select a privilege (see the Searching for and Viewing a Privilege section).
2 From the left navigation pane, click Delete Privilege. The Delete Privilege Information page
opens.
142
3 Ensure that the correct privilege is displayed on the screen.

Note: If the incorrect privilege is displayed, click Cancel, and then click Delete Privilege to start
4 Click Delete.
Permissions
The type of access you can assign to a group is determined by the permissions and resources your
company has defined.
Permissions are access rights set at the resource level, for example, applications and objects.
Before granting group permissions to access available resources, create a reference list of
permissions using the command line tool.
Permissions are usually denoted by the functions that a user can perform on a resource, such as
logging in to a Service Management Platform application, or creating, editing, viewing, or printing
data.
When assigning permissions, remember that some resources have a hierarchical structure, in which
the parent resource has sub-resources, or child resources. This relationship is expressed using a dot
notation, for example, if the parent resource is ComputerA, then a child resource could be
ComputerA.printer. Children automatically inherit permissions granted to the parent, unless you
specify otherwise as shown in the table below.
Resource Permission
computer (parent) print, read, write
computer.printer (child) print
computer.printer.HP1 (child) print
computer.disk (child) read, write
computer.disk.C (child) read
In the table above, computer is the parent and all the resources listed below it are child resources.
The child resources automatically inherit the access privileges granted to the parent, meaning that
143
initially they all have print, read, and write permissions. New permissions can be specified for each
child resource.
Searching for and viewing a Permission
You can view a description of a permission, the date it was created or modified, and the name of the
person who created or modified it.
To search for and view a permission, perform the following steps:
2 Click Privileges.
3 From the left navigation pane, click Search Permission. The Search Permission page opens.
4 Enter a permission name in the field provided, or enter an asterisk (*) to perform a wildcard
search, which will display a list of all existing permissions currently in the database. The
Permission Search Results page opens.
5 If the search result returns more permissions than can fit on one page, click Next to view the next
page, and click Back to view the previous page, as needed.
The Search Results list displays the name of the permission and provides a description for it.
144
6 Select a permission from the Search Results list (for example, changeOwnPassword). The View
Permission Information page opens.
Accessing the External Application from SPM Web
The External tab in the SPM Web is reserved for linking to external applications as required by
specific implementations. Before accessing external applications from the SPM Web, ensure that the
External tab is available in your implementation
To access the external Application, perform the following steps:
1 Click the External tab in SPM Web.
The sub-tab for external applications (for example, Yahoo) and the Help sub-tab appear.
2 Click the External application sub-tab (for example, click Yahoo).
3 Click Help to gain an understanding of Sigma Provisioning Component information.
145
Sigma Provisioning Topology and STM Configuration
Service Topology Manager (STM) Web UI
Once the application is deployed, you can use the STM Web UI to search for consumable resources,
to search for a network element, to search for a subnetwork element, to view technology platform
details, to view and delete a link, as well as to create, update, and delete network elements. The STM
comes pre-installed with Sigma Provisioning.
• Accessing the STM Web UI
• Searching for Consumable Resources
• Searching for a Network Element
• Searching for a Subnetwork Element
• Viewing a Link
• Viewing Technology Platform Details
Accessing the STM Web UI
You can access STM from the following URL on nodes where the smp module is deployed:
• https://{host}:{port}/stmgui
Use the following credentials to log in to STM:
• User: superuser
• Password: superuser
• URL: https://{host}:{port}/stmgui
The user should belong to the stm.SuperUser group. The user password may be different in your
environment. Once logged in, the STM Web UI appears.
146
147
Searching for Consumable Resources
To search for consumable resources in the existing topology, perform the following steps:
1 Log in to STM and click the Consumable Resources tab.
2 Under the Consumable Resource Tree section drill down to find the appropriate consumable
resource. Once you locate it, click on it to obtain information about it. This information is displayed
under the Consumable Resource Information section.
3 You can also search for a consumable resource using the Search Consumable Resources tab.
When you click this tab, the Search Consumable Resources window appears. Enter the criteria
you want to use, and then click the Search button.
The STM Search Result For Consumable Resources window appears with the Unique ID,
Address Value, and Status information for the consumable resource. Click the Back To Search
Menu button to go back to the search menu. You can also view this information by clicking the
Search Results tab located beside the Search Consumable Resources tab.
148
4 To refresh your search results, click the Refresh tab located beside the Search Results tab.
Searching for a Network Element
To search for a network element in an existing topology, perform the following steps:
1 Log in to STM and click the Network tab.
2 Under the Network Topology Tree section drill down to find the appropriate network element.
Once you locate it, click on it to obtain information about it. This information is displayed under the
Network Typology Details section.
In the following example the Property and Value information is Network Element Type and cm,
and Element Count and 22 (respectively).
149
3 You can also search for a network element using the Search Networks tab. When you click this
tab, the Search Network window appears. Enter the criteria you want to use, and then click the
Search button. The dialog also supports pattern matching with wild card (%) search criteria. In the
following example the Exact Match button is selected in order to search for
NEWYORK_HEADEND.
After the Search button is clicked, the pattern matching results of the search appears in the
window.
150
4 Click the appropriate network element from the list that is provided. In this example,
NEWYORK_HEADEND was selected from the list. It is then displayed under the Network
Topology Tree section (color highlighted), and its information is displayed in the Network
Topology Details section.
5 Click the Refresh tab located beside the Search Results tab to refresh your search results.
Searching for a Subnetwork Element
To search for a subnetwork element in an existing topology, perform the following steps:
2 Under the Network Topology Tree section drill down to find the appropriate subnetwork element.
Once you locate it, click on it to obtain information about it. The following subnetwork element
Property and Value information is displayed under the Network Typology Details section:
151
3 You can also search for a subnetwork element using the Search Networks tab. When you click
this tab, the Search Network window appears. Enter the criteria you want to use, and then click
the Search button. The dialog also supports pattern matching with wild card (%) search criteria. In
the following example the Like Match button is selected in order to use % for a cm% wild card
search.
After the Search button is clicked, the STM Search Result For Subnetworks window appears with
the pattern matching results of the wild card search.
152
4 Click the appropriate subnetwork element. In this example, the cm-10077 subnetwork element
was selected from the list. It is then displayed under the Network Topology Tree section (color
highlighted), and its information is displayed in the Network Topology Details section.
5 Click the Refresh tab located beside the Search Results tab to refresh your search results.
153
Viewing a Link
To view a link from one subnetwork to another subnetwork in an existing topology, perform the
following steps:
2 Locate the subnetwork whose link you want to view (using the steps found in the Searching for a
Subnetwork Element section above).
3 Under the Network Topology Details section click the Show Details button for the Serves and
Served By sections.
When you click Link Details >> the Served By > Link Information section appears. This section
contains the details of the link. You can also delete a link by clicking the Delete Link... button (see
the Deleting a Link section below for more details). Click << Back to go back to the Served By
section. In this example, Serviced Area was clicked in order to reveal the Link Details>> link for
BROOKLYN_AMP_1001_12.
154
Viewing Technology Platform Details
To view the details of a technology platform associated with a network subtype, perform the following
steps:
2 Under the Network Topology Tree section drill down to find the appropriate subnetwork element
to view the technology platform details associated with the network instance. Once you locate it,
click on it to obtain information about it. This information is displayed under the Network Topology
Details section.
3 Click the Show Details button beside the Technology Platforms section. Information about the
technology platforms associated with the network subtype appear.
155
4 You can also search for technology platform details by using the Tech Platforms tab. Click this tab
to access the Technology Platform Tree and the Technology Platform Details sections. Drill
down in the Technology Platform Tree section to find the appropriate subnetwork element to view
the technology platform details associated with the network instance. Once you locate it, click on
it to obtain information about it. This information is displayed under the Technology Platform
Details section.
156
Service Topology Manager (STM) Projects
• Navigating the STM Web UI
• Creating a Network
• Modifying a Network
• Creating a Link
• Assigning a Technology Platform
• Deleting a Link
• Deleting a Network
The STM Web UI supports the following generic STM projects. These projects model networks and
links that are needed for provisioning. The following are simple projects with atomic operation.
STM Project Name Description
create_network_element A generic project to create a network.
modify_network_element A generic project to modify network parameters.
delete_network_element A generic project to delete a network.
create_link A generic project to create a link between two networks.
delete_link A generic project to delete a link between two networks.
assign_technology_platform A generic project to assign a technology platform to a network.

Note that only the “provision” management mode is supported
Implementation teams can configure the AllowedTopologyActionMenu.xml file to use these STM
projects based on the topology model and the use cases.
Consider the following sample configuration:
<smp_config xmlns="http://www.sigma‐systems.com/schemas/3.0/SmpConfig" xmlns:xi="http://www.w3.org/2001/
XInclude" xmlns:xsi="http://www.w3.org/2001/XMLSchema‐instance" xsi:schemaLocation="
http://www.sigma‐systems.com/schemas/3.0/SmpConfig ../../../../xmlcfg/schemas/master.xsd
http://www.sigma‐systems.com/schemas/3.0/GenericProject ../../../../xmlcfg/schemas/
allowed_topology_action_menu.xsd
">
<cfg_elem>
<AllowedTopologyActionMenu xmlns="http://www.sigma‐systems.com/schemas/3.0/GenericProject"
xmlns:sc="http://www.sigma‐systems.com/schemas/3.0/SmpConfig" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xsi="http://www.w3.org/2001/XMLSchema‐instance" xsi:schemaLocation="http://www.sigma‐systems.com/
schemas/3.0/GenericProject
../../../../xmlcfg/schemas/allowed_topology_action_menu.xsd">
<!‐‐Subnetwork‐‐>
...
<SrcComponent comp_type="subntwk" comp_sub_type="headend">
157
<TargetComponent comp_type="subntwk" comp_sub_type="cmts_docsis" ref_topology_action="create"
menu="Create Child Element" sub_menu="Create Cmts Docsis"
ref_template_implementation_name="create_network_element"/>
</SrcComponent>
<SrcComponent comp_type="subntwk" comp_sub_type="cmts_docsis">
<TargetComponent comp_type="subntwk" comp_sub_type="cmts_docsis" ref_topology_action="update"
menu="Modify" ref_template_implementation_name="modify_network_element"/>
<TargetComponent comp_type="subntwk" comp_sub_type="cmts_docsis" ref_topology_action="delete"
menu="Delete" ref_template_implementation_name="delete_network_element"><![CDATA[if
menu_choice.src.subnetwork.number_of_children != "0" then "Cannot delete. There are children or served
subnetworks under this subnetwork." else "1"\]]></TargetComponent>
<TargetComponent comp_type="subntwk" comp_sub_type="docsis_cmts_mac_domain"
ref_topology_action="create" menu="Create Child Element" sub_menu="Create Docsis CMTS Mac Domain"
ref_template_implementation_name="create_network_element"/>
<TargetComponent comp_type="link" comp_sub_type="dns_server" ref_topology_action="create"
menu="Create Link" sub_menu="Create Link To DNS Server" ref_template_implementation_name="create_link"/>
<TargetComponent comp_type="link" comp_sub_type="dhcp_server" ref_topology_action="create"
menu="Create Link" sub_menu="Create Link To DHCP Server" ref_template_implementation_name="create_link"/>
<TargetComponent comp_type="techn_platform" comp_sub_type="vital_access"
ref_topology_action="assign" menu="Assign Tech Platform" sub_menu="Assign Vital Access Tech Platform"
ref_template_implementation_name="assign_technology_platform"/>
</SrcComponent>
<!‐‐Link‐‐>
<SrcComponent comp_type="link" comp_sub_type="logical">
<TargetComponent comp_type="link" comp_sub_type="logical" ref_topology_action="delete"
menu="Delete" ref_template_implementation_name="delete_link"><![CDATA[if
menu_choice.src.link.to_subnetwork_type == "cm" then "Cannot delete. There are cable modem(s) served by
this subnetwork." else "1"\]]></TargetComponent>
</SrcComponent>
...
</AllowedTopologyActionMenu>
</cfg_elem>
</smp_config>
Note: All of the examples and screen shots in this section are based on the SMP Demo
implementation configuration. The menus and network names you will eventually see depends on
your own implementation.
158
Navigating the STM Web UI
The STM Web UI can be accessed from the https://{host}:{port}/stmgui URL.
Note: The user should belong to the stm.SuperUser group to be able to run STM Projects.
Based on the AllowedTopologyActionMenu.xml file configuration, the UI will show project menus on
the supported networks.
159
To navigate the UI, perform the following steps:

1 Click the drop-down menu in the Network Topology Tree to view the supported projects that are
on the network.
2 Use the main Projects menu to view the status of the previously run project. Any open/failed
projects can be aborted from here by clicking the Abort button. The associated network can then
be unlocked for the execution of a new project.
160
Creating a Network
To create a network, perform the following steps:
1 Navigate to the parent network that is located under the Network Topology Tree, and select the
appropriate Create network menu. In this example, the Create Cmts Docsis menu is chosen.
2 Fill in the appropriate network details in the Create Cmts Docsis window, and then click the
Create button to create the STM project.
161
3 Review the project execution status information by clicking the OK button in the pop-up window,
and then by clicking the Close button in the Create Cmts Docsis window.
4 Click the Refresh button to refresh the network UI, and then navigate to the parent network under
the Network Topology Details section to view the newly created network.
162
Modifying a Network
To modify a network, perform the following steps:
1 Navigate to the network that is located under the Network Topology Tree, and select Modify from
the drop down network menu.
163
2 When the Update Subnetwork screen appears, modify aspects of the network you have chosen
either by filling in the text fields, or selecting values from the drop down menus.
Note: The subntwk_nm* and status* fields cannot be modified.
3 After you have modified the network by filling in the requisite fields, click Update. You can also
click Abort to cancel the modification.
Note: Based upon customer specific implementations, there may be an instance where the option is
presented in the drop down menu to modify a subnetwork, but when the screen appears there are no
editable fields to make the modification. This indicates that the subnetwork in question cannot be
modified.
164
Creating a Link
To create a link, perform the following steps:
1 Under the Network Topology Tree, navigate to the network where you want to create a link, and
then select the appropriate Create Link menu. In this example, the Create Link To Network
Server Cluster menu is chosen.
2 Search the target subnetwork for the network to which you want to create the link by entering your
search criteria. Once you enter your search criteria, click the Search button. Pattern matching
through the use of wildcard % search criteria is supported. In this example, the NEWYORK%
wildcard is used. This dialog uses the topology model to restrict the type of networks you can
select for the link. This eliminates any incorrect user selections.
165
3 Select the correct network instance from the search results, and then click the Create Link button
to create the link.
4 Click the Close button once you have reviewed the project execution status to your satisfaction.
166
5 Click the Refresh button to refresh the network UI, navigate to the Served By section under the
Network Topology Details section, and then click the Show Details button to view the newly
created link.
Assigning a Technology Platform
To assign a technology platform, perform the followings steps:
1 Navigate to the network under the Network Topology Tree section and select the appropriate
Assign Tech Platform menu. In this example, the Assign Vital Access Tech Platform menu
option is chosen.
167
2 Select the technology platform instance from the Tech Platform list on the Assign Vital Access
Tech Platform window. Once you have selected it, click the Assign button.
3 Review the project execution status to your satisfaction, and then click the Close button.
4 Click the Refresh button to refresh the network UI, navigate to the Technology Platforms section
under the Network Topology Details section, and then click the Show Details button to view the
newly assigned technology platform.
168
Deleting a Link
To delete a link, perform the followings steps:
1 Navigate to the appropriate network under the Network Topology Tree section and select the
network. Under the Network Topology Details section click the Served by button and identify the
network on the other end of the link that you want to delete. Click the Delete Link... button.
2 Verify the information in the Delete Link? window to your satisfaction, and click the Confirm
button.
3 Review the project execution status in the Delete Link? window to your satisfaction, and click the
Confirm button.
169
Deleting a Network
To delete a network, perform the following steps:
1 Navigate to the network you want to delete under the Network Topology Tree section and select
the Delete option from the drop-down menu.
2 Verify the information in the Delete Subnetwork? window to your satisfaction, and click the
Confirm button.
3 Review the project execution status in the Delete Subnetwork? window to your satisfaction, and
click the Confirm button.
170
Note: The following error message will appear in the Delete Subnetwork? window if the network
you want to delete is still associated with child networks.
171
Archiving and Purging the Database
Overview
The Sigma Provisioning Archiving and Purging Utility (the AP tool) automates the separation and
storage of historical data from the working data set. This prevents system slowdown and oversized
database tables caused by the accumulation of historical data.
There are two major parts to the archiving and purging process:
• Preparing a set of records
• Deleting or copying the set of records
The AP tool purges from CM schema only, it does not purge any metadata in the Sigma Provisioning
database. The WF data purge happens inside CM schema.
The AP tool self-configures itself based on input in the arch_purge_env.properties and
arch_purge.properties files. A user selection of archive, purge modes, and entities such as
subscriber, sub_order, and workflow is very important for a successful run. The AP tool first collects
the keys into temporary "driving" tables for the records that needs to be archived or purged based on
the selection criteria defined in arch_purge.properties. The tool then uses these driving tables to
archive or purge the data from CM schema more efficiently. The driving tables are created on the
dedicated AR schema used by the utility and are reinitialized for each run.
172
Archiving Framework and Reporting
The AP tool uses a dedicated database user and tablespace configured in the
arch_purge_env.properties and arch_purge.properties files. The default installation uses the
standard Sigma Provisioning database user naming convention with the AR suffix for both the
database user as well as the tablespace name.
Note: The AR database user has to be created by the Oracle SYSTEM user using the
create_arch_user.sh script. This sets up the table space and the necessary privileges for the AR
user.
Based on the user input in arch_purge.properties for parameter TRUNCATE_ARCH_USER, the AR
Schema can be truncated at the end of the run. For any troubleshooting and debugging purposes,
before truncating the AR user, it is backed up using the Oracle export pump in the directory specified
in the DATAPUMP_DIRECTORY parameter of arch_purge.properties. The export filename is uniquely
named with the convention exp_ARCH<run_id>.dmp.
Note: Ensure that the version of the Oracle client on the application server matches the Oracle server
version.
173
You have to export the archive data on the AR schema from the previous run to an offline storage, as
each run would clean the AR schema. The setting INTERACTIVE_MODE in arch_purge.properties
would make the tool to prompt if the AR schema already has data from a previous run. For
automating the tool as a part of a cron job, you can disable the interactive mode.
Each time an archive or purge is run, a run_id with start or end times, and the number of records
archived or purged from respective logical entities, is stored in the ARCH_LOG table in the CM schema.
The ARCH_LOG tables contains the following information for each run:
• ARCH_RUN_ID
• START_DTM
• END_ARCH_DTM
• END_DTM
• ARCH_SUB_CNT
• ARCH_SUB_SVC_CNT
• ARCH_SUB_ORDR_CNT
• ARCH_ROOT_INSTANCE_CNT
• SUCCESS_FLAG
If there are errors during the archive or purge process, the tool logs the records that generated the
error to respective ERR$_nnnnn tables, created using the DBMS_ERRLOG.CREATE_ERROR_LOG() Oracle
package.
Archiving and Purging Options
Utility Processes
Depending on the user criterion specified in arch_purge.properties, the AP tool performs one of the
following processes:
• Archiving only (ARCHIVE mode)
• Purging only (PURGE mode)
• Archiving and Purging (ARCHIVE-PURGE mode)
The following subsections describe the process in each of these modes.
ARCHIVE Mode
In ARCHIVE mode, the AP tool performs the following five processes:
1 Uses the Oracle sequence ARCH_SEQ to keep track of the next available archival/purge run.
2 Cleans the AR schema from previous runs.
3 Replicates all tables (minus indexes, constraints, triggers, packages, procedures, and functions),
except for 36 transactional tables from the CM schema, using the Oracle 11g data pump utility.
4 Creates driving tables based on the criteria specified in arch_purge.properties for the desired
entities (namely, subscriber, sub-order, and jwf).
174
5 Archives the 36 tables as driven by the respective driving tables for subscriber, sub-order, and jwf.
PURGE Mode
In PURGE mode, the utility performs the following processes:
1 Follows steps 1, 2 and 4 in the ARCHIVE mode (if archiving was not done).
2 Performs one of the following (depending on your selection of the transaction mode):
• LOW VOLUME transactional mode: Deletes the data from the production schema.
• HIGH VOLUME transactional mode: Disables constraints, drops all indexes on the 36
transactional tables, deletes the data from the production schema, enables constraints, and
then re-creates the respective indexes.
ARCHIVE‐PURGE Mode
In the ARCHIVE-PURGE mode, the utility performs the tasks in the ARCHIVE mode, and then the
tasks in the PURGE mode.
Setting Up arch_purge.properties for the Utility
The arch_purge.properties of the AP tool has the following four levels:
A and P Mode
At the highest level, the selection is between two A and P modes: LOW- VOLUME and HIGH-
VOLUME.
• HIGH-VOLUME: This is suitable for removing more than 50% of the data from a table. This has to
be done in offline mode (that is when the application servers are down).
• LOW-VOLUME: This should be used on a regular basis to keep the tables sized properly for
optimal performance.
Archive Group
After selecting an A and P mode, you select one of two archive groups, each of which is a collection
of related tables to be considered together for the sake of consistency, and for maintaining the
schema's referential integrity.
The two groups are the following:
• Subscriber
• Sub Order (SMP Orders)
Note: While selecting at the subscriber level, we are also archiving/purging at the subscriber
service level.
175
Filtering Criteria
After selecting an archive group, you select the filtering criteria. For example, you may specify that
orders older than 20 days from the Sub Order Archive Group are to be purged. In this case, orders
that are older than 20 days will be purged, along with all of the associated records from the other
tables in the Archive Group.
Archive Mode
The final step is to indicate one the following archive modes:
• ARCHIVE-PURGE (which archives, then purges)
• PURGE (which only purges)
• ARCHIVE (which only archives)
For more information on the different options when setting up for archiving and purging, see Archiving
and Purging Options Details.
Note: If a user selects to do ONLY the purge run without archiving, the CM schema data is physically
lost and no recovery of such data is possible.
Archiving and Purging Options Details
A and P Transactional Modes
The two A and P transactional modes use two purge methods with different algorithms that are
optimized for different situations.
• High-Volume Purge Algorithm: For purging with archiving, after creating the driving tables
based on the user criterion specified in arch_purge.properties, the archiving option triggers the
export of all metadata tables. And for the transactional tables, "bulk insert" with the append
operation is run for optimal performance. For the purge option, it starts with dropping constraints
and indexes and then "bulk deletes" from the transactional tables, followed by the creation of
indexes and constraints.
• Low-Volume Purge Algorithm: In this mode, for archiving and purging, the archiving is similar to
the High- Volume mode (as just mentioned). For purging, it starts deleting the transactional data
in reverse entity order, such as Workflow, sub-ordr, sub-svc, and then subscribers.
Archive or Purge Groups
When an archive group is selected, the tables shown in the appropriate diagrams below will be
archived, purged, or archived-purged.
Note: Each box in the diagram represents the physical implementation/table name of the entity.
176
Subscriber Archive/Purge Group
Subscriber Archive/Purge includes the SUB, SUB_SVC, and SUB_ORDR groups.
The following diagram illustrates the Subscriber Archive Group tables:
The following diagram illustrates the Sub Order Archive Group tables.
The following diagram illustrates the Sub Order Archive Group tables.
Workflow Orders are purged by root_instance_id. Additionally, if all instances belonging to a

particular root instance are being purged, the root instance will also be removed (and likewise for
process definitions). Only the dynamic processes definitions associated with root_instance_id will
be purged. The static process definition inside the Tech Cartridge is not purged.
177
The following diagram illustrates the WF Archive Group tables.
Filter Criteria
You can specify the following filter criteria for the respective archive groups:
• JWF:
• Workflow Order Days Range (the default set up is WF orders in the closed.completed.all
status)
• Sub Order:
• Order Days Range (only orders in the closed.completed.all status)
• Subscriber:
• Created Date Range (only the subs with status DELETED are purged)
• Modified Date Range (only the subs with status DELETED are purged)
178
Operation Modes
Operation Modes Table
The following table contains all of the archiving and purging operation modes.
Mode Subscriber Criteria Sub_Ordr Criteria WF Criteria
SUB_CDATE SUB_MDATE SO-date-days RI-date-days
A S, SS, SO S, SS, SO
P S, SS, SO S, SS, SO
AP S, SS, SO S, SS, SO
A SO
P SO
AP SO
P JWF
Operation Modes Table Key
• A = Archiving mode
• P = Purging mode
• AP = Archiving and Purging mode
• S = Subscriber entities
• SS = Sub_Svc entities
• SO = Sub_ordr entities
• WF = Workflow entities
• RI = Root Instance or Workflow Order ID
Transaction Modes
• High Volume: This is typically used when a large volume of data needs to be archived/purged.
• Low Volume: This is used for the archive/purge of data done as part of a daily/weekly/monthly
SMP operational maintenance task.
Note: When working a DB with a large number of Subscribers and Orders, it is recommended that
the DB be periodically analyzed based on Oracle recommendations. Typically the DBAs perform
this as part of normal system operation and maintenance.
179
Guidelines
For the optimum performance of the archive and purge utility, following these guidelines:
1 Before starting the AP Tool, check if the DB needs analyzing by running the following query:
select min(to_number(to_char(sysdate,'yyyymmdd')) ‐ to_number(to_char(last_analyzed,
'yyyymmdd'))) Days 
from user_tables where table_name in ('INSTANCE', 'SUB_ORDR','SUB_SVC','SUB');
a. If the output of the above query is less than or equal to five, then there is no need to analyze
the SMP User/Schema.
b. If the output of the above query is greater than five, then analyze the SMP User/Schema.
2 After each purge operation, it is recommended to analyze the schema. If more than 10% of the
data was purged, then you should analyze the schema to avoid performance impacts to
provisioning.
Configuring the Archive and Purge Environment
Prerequisites
The AP tool requires a dedicated Oracle schema called {name}AR (following the Sigma Provisioning
naming convention). The user schema needs to be created with the provided helper script as
described below by Oracle system user.
The tool needs to be installed on a linux host, which has an Oracle client installation that is compatible
with the Oracle DB Server version.Typically, it is the host where the smp-tooling Docker container is
deployed.
1 Get the Maven artifact (smp.dist‐{VERSION}‐dist.jar) from either the smp-tooling container or
the artifactory.
a. To get the file from the smp-tooling container, run the following command:
$ sudo docker cp {smp‐tooling‐container}:/ /home/smp/runtime/lib/com/sigma/samp/core/
smp.dist/{VERSION}/ smp.dist‐{VERSION}‐dist‐test.jar smp.dist‐{VERSION}‐dist‐test.jar
b. To get file from the artifactory, run the following command:

$ curl ‐O http://artf01.sigma‐systems.com:8081/artifactory/libs‐release‐local/com/
sigma/samp/core/smp.dist/{VERSION}/smp.dist‐{VERSION}‐dist‐test.jar
2 Extract the AP tool from the artifact and set it up under the {SMP_HOME} directory by running the
following commands:
$ jar xvf ../smp.dist‐{VERSION}‐dist‐test.jar tools/com.sigma.samp.core/
samp.util.db_arch_purge_util
$ cd tools/com.sigma.samp.core/samp.util.db_arch_purge_util
$ chmod +x setup_standalone_arch_purge.sh
$ ./ setup_standalone_arch_purge.sh {SMP_HOME}
180
Procedure
To configure the archive and purge environment, perform the following steps:
1 Update all the environment variables in $SMP_HOME/util/setEnv.sh.
2 Under $SMP_HOME/env, set up the following in the arch_purge.properties and
arch_purge_env.properties files:
• Environment variables in the arch_purge_env.properties and arch_purge.properties files.
• Archive and purge modes and criteria in arch_purge.properties.
• Create the archive schema by running the create_arch_user.sh script as the Oracle
SYSTEM user:
./create_arch_user.sh <pdb_system_user> <pdb_system_password> <cdb_sid>
<cdb_system_user> <cdb_system_password>
Note: The creation of the arch user has to be done only once.
3 Run the archive and purge utility:
./run_archive_purge.sh | tee run_archive_purge.log
Note: The tee command is used to put the AP tool output into one log file.
In production environments, the tool is scheduled to run periodically through a unix cron job, based on
business needs.
Environmental Variables
The following Oracle environment variables should be set to the SMP‐CM Oracle schema, and the
corresponding Oracle db‐instance. The DB environment variables are sourced from the
{$SMP_HOME}/util/setEnv.sh script.
Example
###From env.properties
export BASE_AP_DIR=`pwd`
# Schema for SMP Archive & Purge
export ARCH_USER=ècho ${SAMP_DB_USER_ROOT}AR | tr "[a‐z]" "[A‐Z]"'
export ARCH_PASSWD=${SAMP_DB_PASSWORD}
export ARCH_TABLESPACE=ècho TS_${SAMP_DB_USER_ROOT}AR | tr "[a‐z]" "[A‐Z]"'
# SMP application schema
export SMPCM_USERNAME=ècho ${SAMP_DB_USER_ROOT}CM | tr "[a‐ z]" "[A‐Z]"'
export SMPCM_PASSWD=${SAMP_DB_PASSWORD}
export ORACLE_SID=ècho ${SAMP_DB} | tr "[a‐z]" "[A‐Z]"'
export DEGREE_PARALLEL=4
###From arch_purge.properties
export TABLESPACE_PATH='/data1/oradata'
export DATAPUMP_DIRECTORY='/data1/oradata/smp_ap_dir'
Note: See the above env variables before running the create_arch_user.sh script.
181
Archive Modes
Perform archiving and purging either independently or together.
Purging can be performed in either the LOW_VOLUME mode or the HIGH_VOLUME mode:
• LOW_VOLUME: This mode performs an entity-level delete operation on each transactional table.
• HIGH_VOLUME: This mode disables the FK constraints and indexes on transactional tables. It
then performs the following operations:
• It performs the delete operation on each transactional table using PK and rowid
• It enables the FK constraints and indexes on the transactional tables.
Example
export ARCHIVE=NO
export PURGE=YES
export PURGE_MODE=HIGH_VOLUME
export PURGE_MODE=LOW_VOLUME
Subscriber AP
The available modes are the following:
• SUB_CDATE
• SUB_MDATE
Variables
• SUB_CDATE: Subscribers to be archived/purged greater than the specified create date. The
value should be set based on the following date format: 'YYYY‐MM‐DD'
• SUB_MDATE: Subscribers to be archived/purged greater than the specified modified date. The
value should be set based on the following date format: 'YYYY‐MM‐DD'
Note: The tool will only archive/purge the standard SMP tables. If an implementation uses
additional tables to model the Subscriber Entity Data (for example, using the External
Repository), then the tool has to be customized to archive/purge data from those tables.
Example
###Subscriber Archive/Purge ‐ START
###SUB_ARCH_MODE <<options>>: SUB_CDATE, SUB_MDATE;
DATE FORMAT('YYYY‐MM‐DD'); NONE
export SUB_ARCH_MODE=SUB_CDATE
export SUB_PURGE_MODE=SUB_CDATE
export SUB_CDATE='2011‐04‐11'
export SUB_MDATE='2011‐04‐01'
###Subscriber Archive/Purge ‐ END
182
Sub‐Order AP
• SO_DATE: The number of days before sysdate.
Variables
• Sub_Ordr_Date_Days: The sub-orders to be archived/purged between the specified range. The
number of specified days will work as (sysdate‐#days) for sub_orders.
Example
###Sub‐Ordr Archive/Purge ‐ START
###SO_ARCH_MODE <<options>>: SO_DATE(Populate SO_DATE_DAYS=
Number of days before sysdate); NONE
export SO_ARCH_MODE=SO_DATE
export SO_PURGE_MODE=SO_DATE
export SO_DATE_DAYS=2
###Sub‐Ordr Archive/Purge ‐ END
JWF AP
• RII_DATE: The number of days before sysdate.
Variables
• RII_DATE_DAYS: The Workflow Orders that are older than so many days to be archived/purged.
The number of specified days will work as (sysdate‐#days) for sub_orders.
Note: JWF Purge is only supported at the JWF level. Archiving is not supported.
Example
###JWF Purge ‐ START
###NOTE:‐ "ARCHIVE" is not supported for Workflow Orders.
###JWF_PURGE_MODE <<options>>: RII_DATE (Populate RII_DATE_DAYS = Number of days before
sysdate); NONE
export JWF_PURGE_MODE=RII_DATE
export RII_DATE_DAYS=11
export STATE_LIST=4
export STATUS="'1,4'"
export THREADS=4
export BATCH_SIZE=1000
###JWF Purge ‐ END
Note: For better performance, the values of variables THREADS and BATCH_SIZE can be changed.
For example: for the Purging 1000K WF order, we can use the following variable values:
THREADS=6 and BATCH_SIZE=10000.
183
Note: The values of the parameters STATE_LIST and STATUS can be changed, according to

customer requirements. See STATE_LIST and STATUS Options for the possible values of these
parameters.
STATE_LIST and STATUS Options
The following tables contains the possible options that are available for STATE_LIST and STATUS.
STATE_LIST
state_id state_nm
1 new
2 ready
3 waiting
4 completed
5 skipped
STATUS
status_id status_nm
1 success
2 failure
3 terminated
4 compensated
5 incomplete
6 suspended
7 cancelled
8 timeout
9 compensating
10 cancelling
11 not_created
184
Sigma Provisioning Licensing
Sigma Provisioning is controlled by a single license file. By default, a valid license is required to start
and provision services for customers, and to use certain local client-side applications.
License Control
The license file has a number of controls in place that are set specifically for each customer. Not all
controls are set for every customer as they depend on the contract negotiated with Sigma.
Licenses control the following:
• Time limit - a set date, after which the platform will no longer start or provision subscribers.
• Policy - each of these elements have a policy set as “hard” or “soft”:
• Hard policy will stop provisioning and running of the software
• Soft policy will still allow provisioning to continue, and mark notification in the log and in the
UI.
Allowing provisioning to continue despite expiry of a license element does not constitute an extension
or grant of license to the customer. It is the responsibility of the customer to ensure adherence to
licensing per the contract executed with Sigma.
License File
Licenses are separately provided to customers for production and non-production environments.
The license file is a plain XML file with two sections, one which lists the licensed components and
another section for configuring the users who will be notified when license thresholds are reached or
when the license expires. The first section is protected by a digital signature, which means users
cannot update this section once the file is signed. The other section can be changed as part of
deployment.
A sample of the editable section is below. A customer must update the smpt-jndi, to-list and cc-list to
ensure the right persons receive the email notifications. The server where this is deployed must have
send mail or another mail service available to allow this to function. Otherwise, no notification will be
received, but it will be entered into the log files.
On the application server, the license file resides under 
${SMP_HOME}/cfg/com/sigma/samp/imp/smp/xmlcfg/smp‐license.xml. 
On startup, the client application looks for the file under the working directory. If not found, the
application provides an option to download the license from the server.Client applications that require
the license file are:
• SCT
• Workflow console
In addition to Sigma Provisioning, some deployments may require additional licensing for reporting
purposes. In this case, a Jasper server license will need to be obtained and deployed. Contact your
Technical Account Manager if you require a license.
185
Obtaining a New License
License files are provided per the terms of your Software License Agreement with Sigma. To obtain a
new license, contact your sales director or Sigma Technical Support.
Downloading the Sigma Provisioning License File
The Sigma Provisioning license file is located on the master server in the case of a clustered
deployment and directly on the server itself in standalone mode.
The Sigma Provisioning license file is located at 
${smp.home}/cfg/com/sigma/samp/imp/smp/xmlcfg/. 
Look for the Sigma Provisioning license file smp‐license.xml.
Several Sigma Provisioning desktop applications require a local instance of the license to run. These
are:
• Service Creation Toolkit
• Workflow Console
When you start any of the Sigma Provisioning applications that require a license, and they cannot find
a valid license, you will be prompted to install a license, either from a local file system or by
downloading it from a server running Sigma Provisioning.
If your local license is missing or expired, the Download License window appears and asks you to
download the license.
To download the Sigma Provisioning license file, perform the following steps:
1 Start the SCT UI on your computer.
If a license file is missing or expired, the Download License window appears and asks you to
download the license.
2 Click Yes. The Sigma Provisioning License Download window appears.
3 Download the Sigma Provisioning license in one of two ways - local or remote.
a. To download a license file from a local directory, provide a directory path on a disk where the
Sigma Provisioning license file is located.
b. To download a license file from a remote location, provide the master server URL and the
user name and password for authentication.
4 Click Download.
If you are downloading the license file remotely, the download is authenticated and you must provide
a user name and password.
Alternatively, you can download the file directly from the server located at:
${smp.home}/cfg/com/sigma/samp/imp/smp/xmlcfg/ smp‐license.xml
and copy it to the GUI application folder.
186
Updating Email Notifications
The Sigma Provisioning license allows an operator to configure notifications related to impending
expiry or nearing/exceeding limits on the number of subscribers or services. The notifications require
an SMTP service to be enabled on the application server.
The license file is a plain XML file with two sections:
• The first section lists the licensed components. This section is protected by a digital signature,
which means users cannot update this section once the file is signed.
• The second section consists of three sub sections for configuring the users who will be notified
when license thresholds are reached or when the license expires. This section can be changed
as part of deployment, as explained in the following procedure.
To update the license file, perform the following steps:
1 Navigate to the location of the existing license file.
2 Back up the existing license file to a name like smp‐license.xml.bkup20140314
3 Open the file using a vi editor and update the email addresses in the license configuration section
below for the following three notification:
a. Volume: You receive an email notification once you reach the limit for how many subscribers
you can provision. This notification is also logged in the server log file.
<license‐configuration>
<notification comment="volume notifications" name="volume">
<email>
<smtp‐jndi>com.sigma.mail.licensing</smtp‐jndi>
<to‐list> abc.abc@xyz.com</to‐list>
<cc‐list> abc.abc@xyz.com</cc‐list>
<bcc‐list> abc.abc@xyz.com</bcc‐list>
<subject>License Upgrade Notice</subject>
<body><![CDATA[Please Upgrade your License for:
{0} The current limit is {1} and your max limit is {2}]]>
</body>
</email>
b. Expiration: You receive an email notification when the license has expired. The notification
includes the date and time of expiration. This notification is also logged in server log file.
</notification>
<notification comment="expiration notifications" name="expiration">
<email>
<to‐list>abc.abc@xyz.com</to‐list>
187
<body><![CDATA[Please Upgrade your License for:
{0} Your License has expired as on {1}]]>
</body>
</email>
</notification>
c. Warning: You receive an email notification warning you the license will expire. The notification
includes the date and time of expiration, and how many days remain until the expiration date
is reached. This notification is also logged in server log file.
<notification comment="expiration warning" name="warning">
<email>
<to‐list> abc.abc@xyz.com</to‐list>
<body><![CDATA[Please Upgrade your License, Your License will
expires on : {0}, {1} Day(s) Remaining ]]>
</body>
</email>
</notification>
</license‐configuration>
After you log on to Sigma Provisioning, you may see the yellow caution as shown below.
Click yellow caution icon. A popup window appears with a notification message as shown
below.
188
In this case, the message matches the warning message configured in the server log and
alarm.log as:
samp-smp_svr1.log.2018-11-16-15:WARN 15:10:59 (Timer-15) sigma.licensing> 216 License
expires on : Fri Nov 20 15:10:59 EST 2015, 3 Day(s) Remaining
All the expiration dates and times included in the email notifications are based on the thresholds
configured in the license file. For example, you can configure a threshold as follows:
<thresholds comment="notification thresholds in days"
expiration="yes">60,30,15,10,5</thresholds>
</license>
<license comment="devel all enabling SigmaAdmin"
component="SigmaAdmin" expiration="12/31/2018 23:59:59" policy="hard">
When the program reaches the time of 23:59:59 at thresholds of 60 days, 30 days, etc. and
compares it to the expiry date 12/31/2018, the program sends notification stating the license file
expires on Dec. 31, 2018, and you have 60 days, 30 days, etc. remaining.
The number of notification emails is based on the current Provisioning and SigmaAdmin license
components. Each component produces one type of email notification. Also, each node produces
an email notification. For example, if a domain has two clusters and each cluster has two nodes,
you will get four emails at once.
4 Save and close the vi editor.
5 Run the cfgupd.sh script from $SMP_HOME/tools, and provide the “license” as area of interest to
this script. This will load the new file into memory. The Sigma Provisioning restart will have the
same effect.
Replacing the License File
If you have a new license file with updated volumes or expiry date provided by Sigma and wish to
place it into production:
1 Log in to the Sigma Provisioning Tooling container using the following Docker command:
docker exec ‐it {smp‐tooling‐container‐name} /bin/bash
2 Back up the existing license file under 
${SMP_HOME}/cfg/com/sigma/samp/imp/smp/xmlcfg/smp‐license.xml as 
smp‐license.xml.bkup{yyyymmdd}.
3 Copy the new license file to ${SMP_HOME}/cfg/com/sigma/samp/imp/smp/xmlcfg/, which
replaces the existing file.
4 Run cd $SMP_HOME/cfg.
5 Run git add com/sigma/samp/imp/xmlcfg/smp‐license.xml.
6 Run git commit.
The Edit window appears. Type "Update license file", then type wq to save and exit.
7 Run the cfgupd.sh script from 
$SMP_HOME/tools/com.sigma.samp.core/tooling.mlgit.cfgupd, 
189
and provide the license as an area of interest to this script. This loads the new file into memory.
The Sigma Provisioning restart has the same effect.
8 Restart the domain for the changes to take effect.
190
Appendix: Authorization Manager Privilege
Matrices
• AM Privilege Matrix
• SPM Privilege Matrix
• Named Queries Privilege Matrix
• Manual Task Web Privilege Matrix
• STM Privilege Matrix
• Management Beans Privilege Matrix
• Workflow Console Privilege Matrix
• SCT Privilege Matrix
AM Privilege Matrix
This section provides a resource matrix specifying the permissions that may be granted to the various
groups for the Authorization Manager resources.
These resources and permissions defined for the core product are provided for illustration purposes
only. The privileges specific to your implementation may be different.
Resource Group Permission Privilege
smp.admin.group am_mgr assign Controls access to all group creation,

create deletion, viewing, updating, assigning
and excluding groups from other groups.
delete
exclude
update
view
smp.admin.group am_mgr assign Controls the user's ability to assign a

[.<group_name>] exclude "group_name" group to other groups or
to exclude it from other groups.
smp.admin.parm am_mgr view Controls access to parameter definition

information.
smp.admin.permission am_mgr create Controls access to permissions.

delete
update
view
191
smp.admin.privilege am_mgr create Controls access to privileges.

delete
update
view
smp.admin.resource am_mgr create Controls access to resources.

delete
update
view
smp.admin.user am_mgr changeOthersPassword Controls access to SMP user

changeOwnPassword information.
create
delete
update
view
smp.admin.user csr_supervisor changeOwnPassword Controls access to own password.
SPM Privilege Matrix
groups for the Service Profile Manager resources.
Note: These resources and permissions defined for the core product are provided for illustration
purposes only. The privileges specific to your implementation may be different. All SPM UI resources
are available on the UI interface, Configuration tab, and AM Resources link.
192
193
The following table shows the privilege matrix for the SPM UI.
samp.web.orders.view_workflow view Controls the visibility of the View Workflow

button on the View Order Details screen.
Grant or revoke the view permission on
this resource to/ from a group in order to
control group access to the View
Workflow feature implemented by the
WorkflowApplet.
samp.regression.Regression csr_admin view Controls the access to Regression tests.

create
execute
samp.web.assoc[.<association_type view Controls associations between entities or

> [.<aEnd_entity_type> update services.
[.<zEnd_entity_type>]]] Example:
samp.web.assoc.Email_Needs_Hsd.
SubSvcSpec:samp_email.SubSvcSpec:
smp_silver_hsd_access
The entity type has a format
<entity_spec_name>:<entity_type
The entity spec name and entity type can
be found in the SPEC definition of the
entity/service.
samp.web.admin_batch.release_ow view Gives the user permission to release

nership ownership of any batch order on a batch
order screen.
For example, some administration user
may release ownership of a batch order
and then another user can take ownership
of that order.
samp.web.batch[.add_order| view Controls operations on orders in a batch

build_dependencies|cancel|submit_ on a batch order screen.
now| take_ownership]
samp.web.chgstatus[<refClassNm > view Controls usage of this resource. Only

[.<current_state>[.<next_state> "deleted" and "active" states are currently
[.< type >]]]] supported.
For example:
samp.web.chgstatus. SiteSurvey.
active.deleted.cable
The refClassNm is as it is specified in the
META (meta.xml or meta_imp.xml files)
definition of the entity, and the type as it is
specified in the SPEC (SubStructure.xml
file) definiton of the entity.
194
samp.web.chgsubstatus csr_admin view Controls visibility to all the status

csr_supervisor transitions for the Change subscriber
status screen.
sub
samp.web.chgsubstatus.active.delet sub view Controls the transition from active to

ed deleted for the subscriber.
samp.web.chgsubstatus.courtesy_bl sub view Controls the transition from courtesy block

ock. deleted to deleted for the subscriber.
samp.web.chgsubstatus.deleted csr_admin view Controls the transition from deleted to any

csr_supervisor other status for the subscriber.
sub
samp.web.chgsubstatus.mso_block sub view Controls the transition from mso_block to

any other status for the subscriber.
samp.web.chgsubstatus[.<current_s sub view Controls the state of this resource.

tate> [.<next_state>]] The states can be two of the following:
active, courtesy_block, active,
courtesy_block, deleted.
samp.web.chgsvcstatus csr_admin view Controls visibility to all service status

csr_supervisor transitions on the Change Service Status
screen.
sub
samp.web.chgsvcstatus.active.court sub view Controls the transition from active to

esy_block. samp_access courtesy block for all subtyped services of
samp_access.
samp.web.chgsvcstatus.active.delet sub view Controls the transition from active to

ed. samp_access deleted for all subtyped services of
samp_access.
samp.web.chgsvcstatus.active.mso sub view Controls the transition from active to MSO

_block block.
samp.web.chgsvcstatus.active.mso sub view Controls the transition from active to

_block. samp_access mso_block for all subtyped services of
samp_access.
samp.web.chgsvcstatus.courtesy_bl sub view Controls the transition from courtesy to

ock. active.samp_access active (resume) for all subtyped services
of samp_access.

ock. deleted.samp_access deleted for all subtyped services of
samp_access.

ock. mso_block mso_block.
195
samp.web.chgsvcstatus.deleted csr_admin view Controls the transition from deleted to any

csr_supervisor other service status.
sub
samp.web.chgsvcstatus.mso_block sub view Controls the transition from MSO block to

any other service status.
samp.web.detach am_mgr view Controls visibility to the detach icon in the

csr menu frame
csr_admin
csr_supervisor
sub
samp.web.display_children_info view Controls user's ability to see the children

services of a composed service on the
view composed service screen.
samp.web.entity[.<ref_class_name> view Controls user's ability to view or edit

[.<entity_type>]] generic entities.
Example:
samp.web.entity.SubSvc.SubSvcSpec:
samp_sub
samp.web.exception am_mgr view Controls visibility to the Java exception

csr_admin details in the error screen.
csr_supervisor
dm_mgr
sub
samp.web.inactive_svc csr_supervisor edit Controls visibility or edit privilege over the

view inactive (ghost) services.
samp.web.menu csr view The top menu resource controls visibility

csr_supervisor to the entire menu.
samp.web.menu[.<menu_name> csr view Controls the user's access to menus and

[.<sub_menu>]] csr_supervisor submenus.
Example: samp.web.menu.app_cfg.meta
Names of the menus can be found in the
XML configuration files containing
information about menu configuration.
Menus are configured inside the
<menu_cfg> elements of configuration
files.
samp.web.menu.admin am_mgr view Controls visibility to the Admin tab.

csr
csr_admin
csr_supervisor
196
samp.web.menu.app_cfg csr_admin view Controls visibility to the Configuration tab.

csr_supervisor
samp.web.menu.services sub view Controls visibility to the Services tab.

sub.secondary
samp.web.menu.services.actions sub view Controls visibility to the Actions menu item

sub.secondary in the Services tab.
samp.web.menu.services.add_edit sub view Controls visibility to the Add/Edit menu

sub.secondary item in the Services tab.
samp.web.menu.services.change_st sub view Controls visibility to the Change Status

atus menu item in the Services tab.
samp.web.menu.services.svc_migra sub view Controls visibility to the Migration menu

te sub.secondary item in the Services tab.
samp.web.menu.services.view sub view Controls visibility to the View menu item in

sub.secondary the Services tab.
samp.web.menu.subscriber sub view Controls visibility to the Subscriber tab.

sub.secondary
samp.web.menu.subscriber.actions sub view Controls visibility to the Actions menu item

sub.secondary in the Subscriber tab.
samp.web.menu.subscriber.add sub view Controls visibility to the Add menu item in

sub.secondary the Subscriber tab.
samp.web.menu.subscriber.edit sub view Controls visibility to the Edit menu item in

samp.web.menu.subscriber.view sub view Controls visibility to the View menu item in

samp.web.orders.actions csr_supervisor view Controls visibility to the order action

buttons on order details screen.
samp.web.orders.actions[.edit|replic csr_supervisor view Controls user's ability to edit or replicate

ate] orders.
samp.web.orders.capture_header_p csr_supervisor view Controls user's ability to capture

arm parameters during the order submission
[.<order_header_parameter_name>] process on the view order screen.
samp.web.orders.line_items.actions csr_supervisor view Controls visibility to the line item action

buttons on the order details screen.
samp.web.orders.line_item_details_ csr_supervisor view Controls visibility of the line item

heade r[.<parameter_name>] parameters on the line item details page.
samp.web.orders.line_item_details_ csr_supervisor view Controls visibility of the order header

order_header[.<parameter_name>] - parameters on the line item details page.
197
samp.web.orders.order_details_hea csr_supervisor view Controls visibility of order header

der_ parms[.<parameter_name>] parameters on order details page
samp.web.orders.queued_order_det csr_admin view Controls visibility of the details of a

ail csr_supervisor queued order in the order details screen.
samp.web.orders.update_header_p csr_admin view Controls the parameters of an order from

arm[.<order_header_parameter_na csr_supervisor update the batch order screen, for orders in a
me>] batch.
samp.web.subparm csr edit Controls the overall edit privilege over all
csr_supervisor subscriber parameters.
sub
samp.web.subparm sub view Controls the overall view privilege over all
subscriber parameters.
samp.web.subparm sub view Controls the view/edit privileges of all

secondary edit subscriber parameter.
samp.web.subparm[.<path_to_a_pa sub view Controls the view/edit privileges of all

rameter_in_subscriber/address/ secondary edit parameters of subscriber/contact/
contacts_path>] address.
Example:
samp.web.subparm.contacts.primary.
address.pref_nm
samp.web.subparm.acct sub edit Controls the acct parameter in the add/

edit subscriber page.
samp.web.subparm.billing_code sub edit Controls the billing_code parameter in the

add/edit subscriber page.
samp.web.subparm.cm_technology sub edit Controls the cm_technology parameter in

the add/edit subscriber page
samp.web.subparm.contacts.primar sub edit Controls the return_segment parameter in

y.add ress.return_segment the address section in the add/edit
subscriber page.
samp.web.subparm.contacts.primar sub edit Controls the serviced_area parameter in

y.address.serviced_area the address section in the add or edit
subscriber page.
samp.web.subparm.corp sub edit Controls the corp parameter in the add or

edit subscriber page.
samp.web.subparm.sub_type sub edit Controls the sub_type parameter in the

add or edit subscriber page.
samp.web.svc csr view Controls the view or edit privilege over all
csr_supervisor edit services.
samp.web.svc sub view Controls the view privilege over all

sub.secondary services
198
samp.web.svc.samp_sub csr view Controls visibility to the samp_sub

csr_supervisor service.
sub
sub.secondary
samp.web.svcparm csr edit Controls the privileges over all service

csr_supervisor parameters.
sub
sub.secondary
samp.web.svcparm csr_supervisor view Controls the privileges over all service

parameters.
samp.web.view_cart csr view Controls the visibility over the view cart
csr_admin button in the menu frame.
csr_supervisor
sub
samp.web.view_cart.analyze_order csr view Controls visibility to the Analyze order

csr_admin button in the view cart screen.
csr_supervisor
sub
Named Queries Privilege Matrix
groups for the Named Queries resources.
Resource Permission Privilege
smp.query[.<query_type>[.<query_ execute Controls user's ability to execute or view the query

name>]] view form for a query.
Example: smp.query.order.LineItemQueryByOrdrId
smp.query.<queryType>.<queryNm> view Controls visibility of columns returned by search

.<columnNm> entity named queries on the search results page
Example:
smp.query.subbrief.SubNameSearch.first_na me
199
Manual Task Web Privilege Matrix
groups for the Manual Task Web resources.
In order to use this resource the implementation should define groups with "view" and "edit"
permissions on this resource and add relevant users to those groups. The AM supports one more
granular level of resource filtering. The group name is equivalent to the old ServiceBroker Group
name (for example, smp.manualqueue.QuebecTel.Openwave).
smp.manualqueue view N/A

edit
STM Privilege Matrix
groups for the Topology Manager resources.
These resources and permissions defined for the core product are provided for illustration purposes
only. The privileges specific to your implementation may be different.
STM (Resources may be identified at stm.SuperUser execute STM top level permission.
tab level for example, lock Controls root access to all
STM.gui.tab.NetworkView, etc.) STM GUI components.
update
unlock
view
STM.congestion_relief.Congestion stm.FtfRebuildConRelief view Controls access to the

Relief stm.QA entire congestion relief
project.
STM.congestion_relief.Congestion stm.SuperUser execute Controls access to the

Relief stm.FtfRebuildConRelief lock entire congestion relief
project.
stm.SuperUser update
unlock
view
STM.congestion_relief.Congestion stm.QA execute Controls access to the

Relief.verification stm.SuperUser lock verification of the
congestion relief project.
update
unlock
view
200
STM.create_subntwk stm.OutsidePlantData execute Controls access to

stm.SuperUser lock creating a network
element. You can specify
update
which ones as well.
unlock
view
STM.delete_subntwk stm.OutsidePlantData execute Controls access to

stm.SuperUser lock deleting a network
element.
update
unlock
view
STM.modify_subntwk stm.OutsidePlantData execute Controls access to editing

stm.SuperUser lock a network element.
update
unlock
view
Management Beans Privilege Matrix
groups for the Management Bean resources in an SMP domain.
To use this resource, the implementation should define a group named administrators, grant it
execute permission, and add relevant users to that group. No further granularity levels are currently
supported.
Resource Group Permission
smp.management administrators execute
Workflow Console Privilege Matrix
groups for the Workflow Console resources.
smp.inventory.WfProcess.cancel execute Controls whether user can cancel a process in the

Workflow Console.
smp.inventory.WfProcess.suspend execute Controls whether user can suspend a process in the

Workflow Console.
201
smp.inventory.WfProcess.resume execute Controls whether user can resume a process in the

Workflow Console.
smp.inventory.WfProcess.terminate execute Controls whether user can terminate a process in the

Workflow Console.
SCT Privilege Matrix
The cfgupg.sh tool and the SCT GUI are used to trigger configuration updates in an SMP domain.
The resources listed below are used by MasterLoader to check permissions for configuration
updates. Use update permission to control this resource. User whose name was provided to the
cfgupg.sh tool, launched with an area_of_interest as a parameter, must have update permission for
the 'smp.xmlcfg.[<area_of_interest>]' resource and be an immediate member of the 'administrators'
group. The configuration itself is organized by Area-Of-Interest and the resources map to the
following list.
smp.xmlcfg.jmflib_cfg update Controls whether user can update the JMF Library configuration.
smp.xmlcfg.labels update Controls whether user can update the label configuration.
smp.xmlcfg.license update Controls whether user can update the license configuration.
smp.xmlcfg.meta_imp update Controls whether user can update the implementation- specific
meta configuration.
smp.xmlcfg.named_query update Controls whether user can update the Named Query
configuration.
smp.xmlcfg.order_mgr update Controls whether user can update the Order Manager
configuration.
smp.xmlcfg.sdp_cfg update Controls whether user can update the Service Delivery Platform
configuration.
smp.xmlcfg.services update Controls whether user can update the Service Catalog
configuration.
smp.xmlcfg.shelf update Controls whether user can update the Shelf Tech Cartridge
configuration.
smp.xmlcfg.smp_cfg update Controls whether user can update the implementation- specific
Tech Cartridge and Tech Impact configuration.
smp.xmlcfg.smp_ref_data_imp update Controls whether user can update the implementation- specific
REF data.
smp.xmlcfg.sub_mgr update Controls whether user can update the Subscriber Manager
configuration (External Repository).
202
smp.xmlcfg.template update Controls whether user can update the workflow process
configuration.
smp.xmlcfg.jwf_cfg update Controls whether user can update the J2EE Workflow Engine
configuration.
smp.xmlcfg.topology_types update Controls whether user can update the STM Topology Type
configuration.
smp.xmlcfg.distribution update Controls whether user can update the distribution configuration
smp.xmlcfg.installation update Controls whether user can update the installation configuration.
smp.xmlcfg.graph_template update Controls whether user can update the Graph template (for future
use).
smp.xmlcfg.graph update Controls whether user can update the Graph layout configuration
(used by Distribution, Installation UI).
smp.xmlcfg.holidays update Controls whether user can update the Workflow Holiday
configuration.

Sigma Provisioning 6.2 Administration and Operation Guide PDF

Transféré par

Informations du document

Titre original

Copyright

Formats disponibles

Partager ce document

Partager ou intégrer le document

Options de partage

Avez-vous trouvé ce document utile ?

Ce contenu est-il inapproprié ?

Droits d'auteur :

Formats disponibles

Sigma Provisioning 6.2 Administration and Operation Guide PDF

Transféré par

Droits d'auteur :

Formats disponibles

Sigma Provisioning

Audience Implementation Role Use of this guide

System Administrators • Operational Maintenance of • Understand the administrative

Business Owners • Overall responsibility for • Understand the

Sigma Provisioning contains the following five components:

3 Click Edit to edit the sigma‐configuration‐server.

6 Review the changes, then click Submit.

10 Click Upload to complete the operation.

5 Review the summary information, and then click Confirm to deploy.

7 Configure the implementation-specific environment configuration for components, such as JEA

11 Once all of the required properties are configured, click Submit.

The status should change to RUNNING.

3 Configure the smp-admin-runtime container details.

To enable Insights integration, perform the following steps:

7 Review the configuration and click Confirm.

The Sigma Provisioning Admin Home page appears.

The Servers page shows the following information:

The Data Source page shows the following information:

• Status: The status of the node. Possible values are:

The Components page shows managed and unmanaged components.

Click the Customize link to display the following controls:

Click the Customize link to display the following controls:

• Current: The number of messages currently being processed in the queue.

• State: The state of the queue. Possible values are:

The following information appears:

The following information appears:

You may search for information using the options available:

4 To add a business subscriber, select “Business”.

5 Overwrite information as required, then click Next.

To View Queued Orders

5 Click Submit Order.

If the order cannot be processed (fails), consider these possible reasons:

5 Perform the following tasks:

To take ownership of a batch, perform the following steps:

• Orders with Suspend / Resumes

9 Enter HSD Access information.

24 In the Shopping Cart page, click Submit Order.

7 Enter the quantity of user service required, then click Next.

6 Enter the valid information in the following fields:

4 Click HSD Access under Services in the left navigation pane.

The high-level steps of this process are the following:

In this case, select Delete in the Change to field.

A list of tasks requiring manual intervention appears.

4 Select the service to migrate in the left pane.

To add service to a resource map definition, perform the following steps:

To add a regional event definition, perform the following steps:

3 Enter the Group Name (for example: *csr).

Column Name Description

Group Name The unique group name. For example: csr.

The View Group Information page is displayed.

6 On this page, you can edit the group's information, as required.

Note: You will be unable to delete a group if it has users attached.

6 Ensure that the correct group is displayed on the screen.

2 Change the Resource Description, as required.

3 Ensure that the correct resource is displayed on the screen.

Column Name Description

Resource Name A unique name for the resource.

Permission Name A unique name for the permission.

3 Ensure that the correct privilege is displayed on the screen.

computer (parent) print, read, write

computer.printer (child) print

computer.printer.HP1 (child) print

computer.disk (child) read, write