AP481 – ASF Mass Market – TELUS Services Interface Agreement

AP481 – Mass Market Phase 1

Application Architecture Specification
Interface Agreement

OMS / Web Clients to TELUS Services / ASF

2010.06.22

1.63
 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

1 Document Headings
1.1 Document Revision History

Version Revision Revision Revision Notes (Include Approved Approved

Date Author Change Request that caused By Date
this Change)
0.1 12/12/04 RBoulianne Created one document from
various deliverables to simplify
signoff process.
0.2 12/14/04 Rboulianne Added some details and cleaned
up some data structures.
0.3 12/14/04 Rboulianne Added issues and cleaned up
some more details.
0.4 12/14/04 Rboulianne Changed Title of document and
updated some
issues/assumptions.
1.0 12/20/04 Rboulianne Updated and cleaned up the
document according to Interface
Meeting of 2004/12/16 & 17 with
OMS/AMDOCS.
1.1 12/21/04 Rboulianne Updated the Assumptions and
Issues.
1.2. 01/05/05 Rboulianne
1.3 01/17/05 Frank Girard Removed INV STAT fields from
Get Service Address Details &
added Leased Loop Flag to Get
Clearance Paths per George
Postnikoff
1.4 01/18/05 Matt Added revisions based on
Musselman AMDOCS review session on
1/18/2005
1.5 01/21/05 Rena Fresh Resynchronization of SAD box
references and clean-up of New
Interface Development Required
1.6 02/04/05 Richard
Boulianne Sign off of the Get Clearance
Paths and Resolve Address
Business Events.
1.7 02/07/05 Richard Resync document with Frank
Boulianne Girard Document of 2005/01/25
Added new fields to Get Service
Address Details and get
Clearance Paths

1.8 02/09/05 Richard Fixed a difference not found

Boulianne during the Resync. Section 3.2
output element Clearance Path
Indicator was removed from the
document.

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

1.9 03/24/05 David Updated the Service Availability

Addison Service Availability Check and
Determine Line Capability (Loop
Qual) Business Events.
1.9 03/24/05 Richard Fixed Resolve Address Request
Boulianne to include the information that
was listed in small print and
should have been placed in the
table of elements.
1.10 2005.03.30 Frank Girard Updated Request/Set Calling
Card PIN to include explanation
for Reserved Flag from Ernie
Price.
1.11 2005.04.11 Frank Girard Added references to ECCOS
address compression table to Get
Service Address BE. This is per
approved CR 2682
1.12 2005.04.12 Richard Added Request Type to
Boulianne Reserve/Unreserve Fict and
normal TNs.
Added NextSequenceKey to
output of Get Service Address
interface.
1.13 2005.04.15 Frank Girard Changed output record format for
Validate Mutually Exclusive
Features to allow for the errant
features to be returned by switch
type back OMSOMS. Per TD #
2269
1.14 2005.04.18 Frank Girard Changed interface type for
Request Pre-firm Assignment to
an Asynchronous call from
Synchronous. Per TD # 3264
1.15 2005.04.19 Frank Girard Updated to clarify requirement for
Get Clearance Paths interface to
show status Z being treated the
same as status N OMSOMS.
1.16 ??? ??? Unknown updates
1.17 2005.04.27 Frank Girard Changed business event Get
Portability Check to Single Line
Portability and PIC-ability Check;
added fields required to perform
both portability and PIC-ability
checks. Per TD # 2227

Changed Single Line Portability

and PIC-ability Check service to
the Service Availability Service
per TD #4170

Changed Get Native NPA/NXX,

Request/Release Telephone
Numbers, Request/Release
Fictitious Telephone Numbers,

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Request COID by NPA/NXX

service to Inventory Service per
TD #4170
1.18 2005.05.11 Frank Girard Removed Request/Provide
Calling card PIN & View Calling
Card PIN as they are moved to
Service Configuration Service
and are no longer within OMS
scope.
1.19 2005.5.30 Jin-Hwee 1. Add “Get TN Portability
Park Results by COID and
Frank Girard NPA/NXX” – CR3192
2. Update “Request/Release
Fictitious TN” and
“Reserve/Un Reserve
Fictitious TN” – CR2625
3. Update CSR ID for relevant
business event – CR3696
4. Re-synced business event
Get Portability Check to
Single Line Portability and
PIC-ability Check with
NetCracker to OMS Services
IA input and output data
elements.
1.20 2005.06.21 Frank Girard Version 1.20 skipped due to
another version incorrectly using
1.20
1.21 2005.06.21 Oliver Kim Too numerous to catalog here –
changed all OMS Services
Synchronous events to match
implementation.
1.21 2005.06.22 Frank Girard Added reference to OMS class of
service in section 1.4.
No version number change
1.22 2005.06.27 Oliver Kim Various changes
1.22 2005.06.29 Frank Girard Corrected ‘Get Provisioning
Attributes’ back to a Synchronous
response. Removed strikeout on
output message table.
No version number change
1.22 2005.07.08 Frank Girard Corrected Input and Output table
in section 5.4 to remove errant
old versions of the tables that
were left behind during editing.
No version number change.
1.23 2005.07.11 Frank Girard Added to description for
Reserve/Un-reserve TN and
ServiceID stating the NetCracker
shall un-reserve first based on
the ‘delta’ of the items used to the
items ordered in OMS RD.
Get Native NPA/NXX added
notes deprecating the input

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

repositioning fields. As they will

not be needed.
1.24 2005.07.17 Oliver Kim “DDS Time Booking Required”
field added to the response for
Get Provisioning Attributes for
CR 3400
1.25 2006.01.13 John Chang Update the reservePort status
LOA as SU, UN, PN
1.26 2006.05.16 Frank Girard Updated ‘Delivery Completion Date’ for
Work Item Status Notification – the usage
type should be “O” optional.
1.27 2006.06.07 Frederick Updated for CR6892 (amend withdrawn)
and CR6746 (suspend provisioning due to
Wang unbook duedate).

1.29 2006.10.18 Joanna Mah Updated section 4.1 and 4.2 to include
changes for HD TTV. 4.1 increased
collection to 3 and 4.2 added new field for
Theoretical BIN speed for ADSL 2+.
1.30 2006.12.08 John Mellon Update “Reserve Port” and “Validate
Configuration” Business Events to reflect
changes made for Imagine Phase 2a.
1.31 2007.01.22 John Mellon Add new Business Event “Validate
Resources” (Sect. 5.10) to reflect latest
feedback from OE/OP review.
Update “Validate Configuration” Business
Event (Sect. 4.4) to reflect original
configuration.
1.32 2007.02.14 Arie Kusnadi Updated “getNativeNpaNxx”
business event. – adding City as
a required parameter

Updated “Picability check” and

“get line portability” as separate
events.

Updated “service availability

check” and “determine loop
qualification” data model to use
the decided product qualifier key
pair.

Moved the “Transfer of call”

business events to the service
availability section.

Updated by strikethroughing the

“get Tn portability by COID and
NPA/NXX as this event is
obsolete.
1.33 2007.02.19 Arie Kusnadi Updated “Service Availability
Check” and “Determine Line
Capability (Loop Qualifications)”
output data model. Also, added
an assumption for each Business
Events.

Updated the “Get Clearance

Path” Business Event to include

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

High Speed Warm Home

Indicator

Moved the Validate Resource

events to be under service
availability
1.34 2007.03.15 Arie Kusnadi Updated the data model input for
the requestOrReleaseFictitiousTn
and reserveNextServiceId
Business Events
1.35 2007.03.29 Arie Kusnadi Updated to deprecate the
getPicability event.
1.36 2007.09.18 Joon Hee Updated Seven events for
Cho CR9276
1:37 2007.12.14 Shoukat NC should return appropriate
Siddiquee Error message to OMS during
Reserve Port CR 9842
1.40 2008.06.05 Shobha Updating document to include
Bahuguna Kiran’s changes in IA v 1.6.
1.41 2008.06.06 Raymond Lai Update for 6Meg Legacy project
1.42 2008.07.8 Shobha Updates for ETTS/GPON project.
Bahuguna/Ni Updating for new pending service
khil Goswami to be added
Added
GetAccessNetworkTypesByServi
ceAddress API which will be
implemented in NC
Added change of technology flag
in check service availability by
address and check service
availability by TN

Removed Get Pending Orders

from Inventory service and added
in Order Service

Shobha Modified getClearance Path for

Bahuguna ETTS/GPON project
1.43 2008-07-23 Shobha Changed name of API Get
Bahuguna Pending Orders to
GetCircuitPaths and also the
input and outputs for ETTS
project

Modified getClearance Path for

ETTS/GPON project
1.44 2008-08-27 Raymond Lai Update Service Tiers details in
section 4.1 to 4.4
1.45 2008-09-15 Raymond Lai CheckServiceAvailability (sec
4.1, 4.2) should return High
Speed 25 status as DQN for non-
ETTS/non-GPON location
(confirmed per Kalpesh)
1.45 2008-11-26 Nikhil Product Service Type(In

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Goswami clearance Path 3.4.4) changed

from Mandatory to optional
1.47 2009/01/08 Shobha Changed Service type code (In
Bahuguna clearance Path 3.4.4) to
Mandatory from optional for
ETTS/GPON as part of defect
54509
1.48 2009/01/14 Shawn Ru Enhanced for DV: 4.5, 4.6, 4.8,
4.15, 5.1, 5.3(made “line”
optional)
1.49 2009/01/16 Seshu Enhanced for DV-SI: 6.6: Notify
Tracking.
1.50 2009/01/16 Shawn Ru fmsAddressId required for Get
Calling Features
1.51 2009/01/30 Shawn Ru Updated 3.4 to make CP DP
code mandatory for DV;
Updated 4.5, 4.6 to add inputs to
differentiate DV and Copper
1.52 2009/02/12 Shawn Ru Updated 4.15 to throw
TNSearchException and add
“Unknown” as a possible return
value
1.53 2009/02/25 Shawn Ru Removed input service_path_id
from Get Calling Features,
Validate Single Line and pic-
ability check;

Added input Order Action Type to

pic-ability check
1.54 2009/03/13 Shawn Ru Added checkPicabilityByAddress;
confirmed to treat blank order
Action type as “Provide” for get
Calling Features, Validate Single
Line and checkPicability
1.55 2009/04/14 Shawn Ru Added LOV (appendix A7) for
Order Action Type for Get Calling
Features, Validate Single Line
and pic-ability check
1.56 2008/06/10 Vivek To remove un used parameters
Agarwal from
NetworkAccessPathDetailDto
1.57 2008/06/11 Shawn Ru Updated LOV for GetServiceID;
Made resource_id conditional as
opposed to optional in Get
Calling Features and Validate
Single Line
1.58 2008/08/26 Abhishek Added Service tiers for Komodo
Joshi
1.60 2009/09/16 Mark Jia Updated specifications for
ServiceId. Removed dashes.

Removed examples of Order

Action Types in PICability check
1.61 2001/04/05 Prinjal Patel Update section

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

4.5 and 4.6 Added ServiceClass

and Service Type attribute to this
method.

Added Method

3.2 Serch
ServiceAddressforBusiness
Services – For SDSE Project

3.3 Get Service Address Details

for Business Services – For
SDSE Project

4.9 GetPicStatus to get the status

for Multiple TNs for SDSE.

1.62 2010/04/23 Prinjal Patel Added section 6.5 for Embargo

CR.
1.63 2010/06/22 Geetanjali Removed Service Type and
Gune Service Class attributes from Get
Calling Features and Validate
Calling Features.
Updated sec 3.2.4 - Search
Service Address for Business
Services and sec 3.3.4 - Get
Service Address Details for
Business Services

1.2 Document Review

This document will be submitted to the following individuals for review and sign off:

Name Role Reviewed

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

1.3 Document Location

\\corp.ads\data\BusTransformation\IS-BC\NewStack\Auto Service Fulfillment

(ASF)\Mass Market Project\3. Gate 3 Deliverables\AP481 Interface Agreements\

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Table of Contents

0 Document Headings..................................................................................................1
0.1 Document Revision History...................................................................................1
0.2 Document Review..................................................................................................1
0.3 Document Location................................................................................................1
1 Introduction................................................................................................................1
1.1 Overview................................................................................................................1
1.2 Related Documentation.........................................................................................1
1.3 Interface Scope......................................................................................................1
1.4 Assumptions..........................................................................................................1
1.5 Issues.....................................................................................................................1
2 Technical Specifications...........................................................................................1
2.1 Interface Description..............................................................................................1
2.2 Common Framework Components.......................................................................1
2.3 Transaction Management......................................................................................1
2.4 Error Handling........................................................................................................1
2.5 Restart/Recovery...................................................................................................1
3 Service Address Service Business Events.............................................................1
3.1 Search Service Address........................................................................................1
3.1.1 Description.......................................................................................................1
3.1.2 System Modifications & Enhancements..........................................................1
3.1.3 Error & Exception Handling.............................................................................1
3.1.4 Interface Data Elements..................................................................................1
3.2 Search Service Address for Business Services....................................................1
3.2.1 Description.......................................................................................................1
3.2.2 System Modifications & Enhancements..........................................................1
3.2.3 Error & Exception Handling.............................................................................1
3.2.4 Interface Data Elements..................................................................................1
3.3 Get Service Address Details for Business Services..............................................1
3.3.1 Description.......................................................................................................1
3.3.2 System Modifications & Enhancements..........................................................1
3.3.3 Error & Exception Handling.............................................................................1
3.3.4 Interface Data Elements..................................................................................1
3.4 Complete Partial Address (was previous Resolve Service Address)...................1
3.4.1 Description.......................................................................................................1
3.4.2 System Modifications & Enhancements..........................................................1
3.4.3 Error & Exception Handling.............................................................................1
3.4.4 Interface Data Elements..................................................................................1
3.5 Get Service Address Details..................................................................................1
3.5.1 Description.......................................................................................................1
3.5.2 System Modifications & Enhancements..........................................................1
3.5.3 Error & Exception Handling.............................................................................1
3.5.4 Interface Data Elements..................................................................................1
3.6 Complete Partial Address (was previous Resolve Service Address)...................1

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

3.6.1 Description.......................................................................................................1
3.6.2 System Modifications & Enhancements..........................................................1
3.6.3 Error & Exception Handling.............................................................................1
3.6.4 Interface Data Elements..................................................................................1
3.7 Get Clearance Paths.............................................................................................1
3.7.1 Description.......................................................................................................1
3.7.2 System Modifications & Enhancements..........................................................1
3.7.3 Error & Exception Handling.............................................................................1
3.7.4 Interface Data Elements..................................................................................1
4 Service Availability Service Business Events........................................................1
4.1 Service Availability Check By Service Address.....................................................1
4.1.1 Description.......................................................................................................1
4.1.2 System Modifications & Enhancements..........................................................1
4.1.3 Error & Exception Handling.............................................................................1
4.1.4 Interface Data Elements..................................................................................1
4.1.5 Sample Event..................................................................................................1
4.2 Service Availability Check By Telephone Number................................................1
4.2.1 Description.......................................................................................................1
4.2.2 System Modifications & Enhancements..........................................................1
4.2.3 Error & Exception Handling.............................................................................1
4.2.4 Interface Data Elements..................................................................................1
4.2.5 Sample Event..................................................................................................1
4.3 Loop Qualification By Address..............................................................................1
4.3.1 Description.......................................................................................................1
4.3.2 System Modifications & Enhancements..........................................................1
4.3.3 Error & Exception Handling.............................................................................1
4.3.4 Interface Data Elements..................................................................................1
4.3.5 Sample Event..................................................................................................1
4.4 Loop Qualification By Telephone Number.............................................................1
4.4.1 Description.......................................................................................................1
4.4.2 System Modifications & Enhancements..........................................................1
4.4.3 Error & Exception Handling.............................................................................1
4.4.4 Interface Data Elements..................................................................................1
4.4.5 Sample Event..................................................................................................1
4.5 Get Calling Features..............................................................................................1
4.5.1 Description.......................................................................................................1
4.5.2 System Modifications & Enhancements..........................................................1
4.5.3 Error & Exception Handling.............................................................................1
4.5.4 Interface Data Elements..................................................................................1
4.6 Validate Configuration: Single Local Line (was Validate Mutually Exclusive
Features).........................................................................................................................1
4.6.1 Description.......................................................................................................1
4.6.2 System Modifications & Enhancements..........................................................1
4.6.3 Error & Exception Handling.............................................................................1
4.6.4 Interface Data Elements..................................................................................1

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

4.7 Check line Portability by Address..........................................................................1

4.7.1 Description.......................................................................................................1
4.7.2 System Modifications & Enhancements..........................................................1
4.7.3 Error & Exception Handling.............................................................................1
4.7.4 Interface Data Elements..................................................................................1
4.8 PIC-ability Check...................................................................................................1
4.8.1 Description.......................................................................................................1
4.8.2 System Modifications & Enhancements..........................................................1
4.8.3 Error & Exception Handling.............................................................................1
4.8.4 Interface Data Elements..................................................................................1
4.9 GetPicStatus..........................................................................................................1
4.9.1 Description.......................................................................................................1
4.9.2 System Modifications & Enhancements..........................................................1
4.9.3 Error & Exception Handling.............................................................................1
4.9.4 Interface Data Elements..................................................................................1
4.10 Get TN Portability Results by COID and NPA/NXX..............................................1
4.10.1 Description....................................................................................................1
4.10.2 System Modifications & Enhancements.......................................................1
4.10.3 Error & Exception Handling..........................................................................1
4.10.4 Interface Data Elements...............................................................................1
4.11 Validate Configuration: Transfer of Call (was Transfer of Call).............................1
4.11.1 Description....................................................................................................1
4.11.2 System Modifications & Enhancements.......................................................1
4.11.3 Error & Exception Handling..........................................................................1
4.11.4 Interface Data Elements...............................................................................1
4.12 Get owner by NPA & NXX.....................................................................................1
4.12.1 Description....................................................................................................1
4.12.2 System Modifications & Enhancements.......................................................1
4.12.3 Error & Exception Handling..........................................................................1
4.12.4 Interface Data Elements...............................................................................1
4.13 Validate Resources...............................................................................................1
4.13.1 Description....................................................................................................1
4.13.2 System Modifications & Enhancements.......................................................1
4.13.3 Error & Exception Handling..........................................................................1
4.13.4 Interface Data Elements...............................................................................1
4.13.5 Sample Events.............................................................................................1
4.14 Get Turbo Flag.......................................................................................................1
4.14.1 Description....................................................................................................1
4.14.2 System Modifications & Enhancements.......................................................1
4.14.3 Error & Exception Handling..........................................................................1
4.14.4 Interface Data Elements...............................................................................1
4.15 GetNetworkTypeBySvcAddress............................................................................1
4.15.1 Description....................................................................................................1
4.15.2 System Modifications & Enhancements.......................................................1
4.15.3 Error & Exception Handling..........................................................................1

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

4.15.4 Interface Data Elements...............................................................................1

4.16 Check Loop Migration Feasibility..........................................................................1
4.16.1 Description....................................................................................................1
4.16.2 System Modifications & Enhancements.......................................................1
4.16.3 Error & Exception Handling..........................................................................1
4.16.4 Interface Data Elements...............................................................................1
4.17 Check PIC-ability By Address................................................................................1
4.17.1 Description....................................................................................................1
4.17.2 System Modifications & Enhancements.......................................................1
4.17.3 Error & Exception Handling..........................................................................1
4.17.4 Interface Data Elements...............................................................................1
5 Inventory Service Business Events.........................................................................1
5.1 Get Service ID.......................................................................................................1
5.1.1 Description.......................................................................................................1
5.1.2 System Modifications and Enhancements......................................................1
5.1.3 Error & Exception Handling.............................................................................1
5.1.4 Interface Data Elements..................................................................................1
5.2 Get Native NPA/NXX.............................................................................................1
5.2.1 Description.......................................................................................................1
5.2.2 System Modifications & Enhancements..........................................................1
5.2.3 Error & Exception Handling.............................................................................1
5.2.4 Interface Data Elements..................................................................................1
5.3 Request / Release Telephone Numbers...............................................................1
5.3.1 Description.......................................................................................................1
5.3.2 System Modifications & Enhancements..........................................................1
5.3.3 Error & Exception Handling.............................................................................1
5.3.4 Interface Data Elements..................................................................................1
5.4 Reserve / Un-reserve Telephone Number............................................................1
5.4.1 Description.......................................................................................................1
5.4.2 System Modifications & Enhancements..........................................................1
5.4.3 Error & Exception Handling.............................................................................1
5.4.4 Interface Data Elements..................................................................................1
5.5 Request / Release Fictitious Telephone Numbers................................................1
5.5.1 Description.......................................................................................................1
5.5.2 System Modifications & Enhancements..........................................................1
5.5.3 Error & Exception Handling.............................................................................1
5.5.4 Interface Data Elements..................................................................................1
5.6 Reserve / Un-reserve Fictitious Telephone Numbers...........................................1
5.6.1 Description.......................................................................................................1
5.6.2 System Modifications & Enhancements..........................................................1
5.6.3 Error & Exception Handling.............................................................................1
5.6.4 Interface Data Elements..................................................................................1
5.7 Reserve/Un-reserve Service ID.............................................................................1
5.7.1 Description.......................................................................................................1
5.7.2 System Modifications & Enhancements..........................................................1

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

5.7.3 Error & Exception Handling.............................................................................1

5.7.4 Interface Data Elements..................................................................................1
5.8 Request COID by NPA/NXX..................................................................................1
5.8.1 Description.......................................................................................................1
5.8.2 System Modifications & Enhancements..........................................................1
5.8.3 Error & Exception Handling.............................................................................1
5.8.4 Interface Data Elements..................................................................................1
5.9 Reserve Port..........................................................................................................1
5.9.1 Description.......................................................................................................1
5.9.2 System Modifications & Enhancements..........................................................1
5.9.3 Error & Exception Handling.............................................................................1
5.9.4 Interface Data Elements..................................................................................1
5.10 Get Provisioning Attributes....................................................................................1
5.10.1 Description....................................................................................................1
5.10.2 System Modifications & Enhancements.......................................................1
5.10.3 Error & Exception Handling..........................................................................1
5.10.4 Interface Data Elements...............................................................................1
6 Service Order Service Business Events.................................................................1
6.1 Request Pre-firm Assignment................................................................................1
6.1.1 Description.......................................................................................................1
6.1.2 System Modifications & Enhancements..........................................................1
6.1.3 Error & Exception Handling.............................................................................1
6.1.4 Interface Data Elements..................................................................................1
6.2 Pre-firm Cancel/Amend Withdraw.........................................................................1
6.2.1 Description.......................................................................................................1
6.2.2 System Modifications & Enhancements..........................................................1
6.2.3 Error & Exception Handling.............................................................................1
6.2.4 Interface Data Elements..................................................................................1
6.3 Suspend Service Order.........................................................................................1
6.3.1 Description.......................................................................................................1
6.3.2 System Modifications & Enhancements..........................................................1
6.3.3 Error & Exception Handling.............................................................................1
6.3.4 Interface Data Elements..................................................................................1
6.4 Request Delivery...................................................................................................1
6.4.1 Description.......................................................................................................1
6.4.2 System Modifications & Enhancements..........................................................1
6.4.3 Error & Exception Handling.............................................................................1
6.4.4 Interface Data Elements..................................................................................1
6.5 Get Circuit Paths....................................................................................................1
6.5.1 Description.......................................................................................................1
6.5.2 System Modifications & Enhancements..........................................................1
6.5.3 Error & Exception Handling.............................................................................1
6.5.4 Interface Data Elements..................................................................................1
6.6 Notify Tracking.......................................................................................................1
6.6.1 Description.......................................................................................................1

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

6.6.2 System Modifications and Enhancements......................................................1

6.6.3 Error and Exception handling..........................................................................1
6.6.4 Interface Data Elements..................................................................................1
7 Delivery Notifications Business Events..................................................................1
7.1 Work Item Status Notification................................................................................1
7.1.1 Description.......................................................................................................1
7.1.2 System Modifications & Enhancements..........................................................1
7.1.3 Error & Exception Handling.............................................................................1
7.1.4 Interface Data Elements..................................................................................1
7.1.5 Sample Event..................................................................................................1
7.2 Due Date Change Notification...............................................................................1
7.2.1 Description.......................................................................................................1
7.2.2 System Modifications & Enhancements..........................................................1
7.2.3 Error & Exception Handling.............................................................................1
7.2.4 Interface Data Elements..................................................................................1
7.2.5 Sample Event..................................................................................................1
7.3 Order Complete Notification..................................................................................1
7.3.1 Description.......................................................................................................1
7.3.2 System Modifications & Enhancements..........................................................1
7.3.3 Error & Exception Handling.............................................................................1
7.3.4 Interface Data Elements..................................................................................1
7.4 Order Delay Notification........................................................................................1
7.4.1 Description.......................................................................................................1
7.4.2 System Modifications & Enhancements..........................................................1
7.4.3 Error & Exception Handling.............................................................................1
7.4.4 Interface Data Elements..................................................................................1
7.5 Non-Doable Work Notification...............................................................................1
7.5.1 Description.......................................................................................................1
7.5.2 System Modifications & Enhancements..........................................................1
7.5.3 Error & Exception Handling.............................................................................1
7.5.4 Interface Data Elements..................................................................................1
7.5.5 Sample Event..................................................................................................1
Appendix A: Common Objects.......................................................................................1
A.1 Address............................................................................................................1
A.2 ServiceAddressDetails....................................................................................1
A.3 TelNum............................................................................................................1
A.4 SA ODS Status Object....................................................................................1
A.5 RIT Code Translations.....................................................................................1
A.6 Business Event Call Type Summary...............................................................1
A.7 Order Action Type LOV...................................................................................1

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

2 Introduction
2.1 Overview

This Interface Agreement document establishes a specification for the interface between ASF Mass Market and
Imagine-OMS. It identifies agreed-upon design requirements and constraints that must be satisfied by the
interfacing systems. This document is intended for use by the developers of the applications identified, and by the
test organizations responsible for the testing of these applications.

2.2 Related Documentation

The following are supporting documents are being used to develop this Interface Agreement:

- ASF Mass Market Application Architecture

- ASF Program MM Scope Definition Phase 1
- ASF Architecture Blueprint
- ASF Mass Market Phase 1 Use Cases
- ASF Mass Market Phase 1 System Activity Diagrams
- NetCracker API to OMS 12_10_04.doc
- FMS API to NetCracker and OMS 12_10_04.doc
- OMS API to Service Availability Service 12_01_04
- PRODN-206333-TELUS OMS – Interface Specifications (JAD Sessions Group 2) Dec7.DOC

2.3 Interface Scope

This document outlines the interface requirements to support the following business events:

- Search Service Address

- Get Service Address Details
- Complete Partial Address
- Service Address Resolution Results
- Get Clearance Paths
- Check Loop Migration Feasibility
- Service Availability Check
- Determine Line Capability
- Get Calling Features
- Validate Configuration: Single Local Line
- PIC-ability check
- Single Line Portability Results By COID and NPA/NXX
- Get Service ID
- Get native NPA/NXX
- Request/Release Telephone Numbers
- Reserve/Un-Reserve Telephone Number
- Request/Release Service ID
- Reserve/Un-reserve Service ID
- Request COID by NPA/NXX
- Reserve Port
- Get Provisioning Attributes
- Validate Configuration: Transfer of Call

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

- Request Pre-Firm Assignment

- Pre-firm Cancel
- Request Delivery
- Work Item Status Notification
- Due Date Change Notification
- Order Complete Notification
- Order Delay Notification
- Non-Doable Work Notification

2.4 Assumptions

This interface agreement makes the following assumptions:

 The Product Transformational Request by AMDOCS will contain all information required for Netcracker
to perform work with legacy systems this include service address, product details, order details, clearance
path and install type information.
 This document represents all interfaces between project Imagine and ASF Mass Market, and any other
interfaces which may exist or will need to be built between Imagine infrastructure and T&O systems are
outside the scope of the ASF Mass Market project.
 Box number references to the ASF MM Master SAD will not change.
 Specified Field Names in Data Elements sections represent names which are understood and unambiguous
to members of both Imagine and ASF Mass Market projects.
 Current definitions of data elements and their formats for the TELUS Services will be acceptable to the
Frameworks team.
 OMS understands that FMS can not validate or retrieve information related to unknown or partial
addresses. For this reason, any FMS related calls requiring a known service address will be limited.
 There is an understanding that Service Address ID and Service Address information will be sent to ASF so
that systems calls to Legacy systems (FMS) can be performed using the Service Address ID and/or the
textual information.
 Clearance Path and Resolve Service Address are part of this Interface agreement but was not reviewed or
discussed during the ASF-MM/OMS meetings.
 OMS class of service values are: “BU” (Business), “CO” (Corporate), “RE” (Residential), “RE” being the
only value expected for Phase 1. “RE” shall map to FMS class of “R”.

2.5 Issues

The following is a set of issues associated with this interface:

 The ASF MM team needs the Product Transformation Request XSD to confirm all information
NetCracker and legacy systems require can be found in it.
 See Test Director for a list of issues that are still open.

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

3 Technical Specifications
3.1 Interface Description

This interface agreement details the methods and components required for an interface between ASF Mass Market
and Amdocs-OMS / WebClients. These external systems will communicate with ASF-MM via TELUS Services
that are J2EE Enterprise Java Beans whose purpose is to abstract ASF backend legacy systems and/or NetCracker.

ASF Mass Market application services will need to handle business event requests via RMI/IIOP to EJBs, perform
all activities required to build and respond to OMS’s requests. In addition to OMS’s synchronous communications,
ASF’s Netcracker application will need to communicate back to OMS in an asynchronous fashion. This will be
achieved by publishing messages via the MQ Message Hub.

RMI/IIOP RMI/IIOP FMS/

Web Clients
SA ODS

Telus
RMI/IIOP Services RMI/IIOP
OMS AMDOCS NetCracker

MQ MQ Message MQ
Hub

3.2 Common Framework Components

Under Weblogic, the developers will need to use to TELUS common framework components for EJBs, MDB and
JMS (MQSI) publishing. These components should use other common framework components if required.

3.3 Transaction Management

When using J2EE, the Application Server’s transaction manager should be able to handle all transactions.

3.4 Error Handling

The error and exception handling common framework components should be used when errors are encountered.

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

3.5 Restart/Recovery

The systems operations and technical architecture groups should have recovery procedures for WEBLOGIC and the
MQ message hub.

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

4 Service Address Service Business Events

4.1 Search Service Address

Event Name Search Service Address

Applicable Products Local Line / Internet Services / TTV/ VOIP
NON-Applicable Products Calling Card / IP Applications / Long Distance
Trigger Customer Request for services outlined under applicable products
Pre-Conditions Partial or full address info has been entered by CSR into the Service Address
Service Web App.
Post-Conditions Either an exact match or a set of possible matches is returned to the Service
Address Web App.
Source System Service Address Web App
Target System FMS Adapter
Protocol Remote EJB call to Service Address Service (SAS) EJB
Remote EJB Call from SAS to FMS Adapter
ITOC (IMS Connect) from FMS Adapter to MegaTran
IMS from MegaTran to FMS
Interface Type Synchronous
Response Requirements Synchronous
Development Required Complete.
Consumer of Service Compass Consumer and DT1 Consumer
4.1.1 Description
A user will enter address information that will be processed by OMS. OMS will submit a request to the Service
Address Service to retrieve the address that matches the entered information. Should it not be found, a list of
possible matches will be returned so the user can select the one that matches. Get Service Address shall invoke the
ECCOS address compression table to the address passed from OMS to compress the long address into the
abbreviated short FMS address format. Ref: CR 2682

The See Boxes 1, 2, and 3 within “Select Service Address” section of Master SAD

4.1.2 System Modifications & Enhancements

4.1.3 Error & Exception Handling

Java Runtime Exceptions will be thrown only in the event of a system error. System errors are defined as
unexpected connection errors or other environment / setup related technical errors. Business errors or errors thrown
by downstream systems will be passed to the client in the form of a Status Message (with an exception of
InvalidAddressException), to be defined as part of the Response Dto. There is some question as to whether or not
we should be throwing these “Business Exceptions” as checked Java Exceptions, rather than as status message /
error code objects. This is a broad question and cannot be addressed in code drop 2. It should be revisited for code
drop 3.

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

InvalidAddressException
searchServiceAddress in Address SVC validates Province and City passed from the calling application by invoking
Region Guiding Component in order to check up front whether or not the call will fail in the FMS Adapter layer.
If the call to Region Guiding component fails due to no match found for the passed Province and City values,
InvalidAdressException is thrown. Refer to CR 9276- Region Guiding Error Handling

4.1.4 Interface Data Elements

Input Data Elements (SearchAddressReqDto)

Field Name Type Length M/O Additional Information
Address (refer to Address M Required Fields:
Appendix A)
Country
Province
City

Fields of Note:

The following if absent will generate “like” returns as

noted in the output elements:
Street – optional
Vector – optional
House Number & Suffix – optional
Apartment – optional

Other fields of note:

AddressType – not currently used. Denotes urban,
rural, civil, legal, lot, block plan, etc.

Csr Id String M The CSR / Csr Id – for auditing.

MaxRecordCount Integer M The maximum number of records to return per page.
NextSequenceKey String O This is not an index – it is a key that FMS will use to get
the next n (specified by max record count) records in the
same query. On the first call it does not need to be set –
on any further calls, it must be set to the value returned
in the Response sub-object (like streets, like apts, etc,
depending on which one is valid).

There are 4 possible outputs (like streets, like houses, and like apartments, address details).
Output Data Elements (SearchAddressRespDto)
Field Name Type Length M/O Additional Information
Search Address Resp
Dto
Like Streets LikeStreets Returned if a “like streets” match occurs – otherwise it
Dto will be null. Type of return is defined in the “type”
property.
Like Houses LikeHouse Returned if a “like houses” match occurs – otherwise it
sDto will be null. Type of return is defined in the “type”

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Output Data Elements (SearchAddressRespDto)

Field Name Type Length M/O Additional Information
property.
Like Apartments LikeApart Returned if a “like apts” match occurs – otherwise it will
mentsDto be null. Type of return is defined in the “type” property.
Details ServiceAdd Returned if an exact match occurs – otherwise it will be
ressDetails null. Type of return is defined in the “type” property.
See Appendix A for definition of ServiceAddressDetails.
Type String Tells you which of the above types was returned by this
search. Enum: LIKE_STREETS; LIKE_APTS;
LIKE_HOUSES; DETAILS.

LikeStreetsDto
Field Name Type Length M/O Additional Information
Address Address The input address that was used as search criteria for this
return. Used so that the web app can maintain state.
Next Sequence Key String The key to use for subsequent calls (to get next pages)
on this query.
Records List A list of LikeStreetsDto.Record objects, defined below.

LikeStreetsDto.Record
Field Name Type Length M/O Additional Information
Street String
Vector String
First House Number String
Last House Number String
Treatment Flag String

LikeHousesDto
Field Name Type Length M/O Additional Information
Address Address The input address used for this search.. Used so that the
web app can maintain state.
Next Sequence Key String See above.
Records List A list of LikeHousesDto.Record objects, defined below.

LikeHousesDto.Record
Field Name Type Length M/O Additional Information
House Number String
House Suffix String For duplexes and the like – usually “A” or “B”, etc.

LikeApartmentsDto
Field Name Type Length M/O Additional Information
Address Address The input address used for this search. Used so that the
web app can maintain state.
Next Sequence Key String See above.

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

LikeApartmentsDto
Field Name Type Length M/O Additional Information
Records List A list of LikeApartmentsDto.Record objects, defined
below.

LikeApartmentsDto.Record
Field Name Type Length M/O Additional Information
Apartment String The apartment number.

4.2 Search Service Address for Business Services

Event Name Search Service Address For Business Services

Applicable Products Local Line / Internet Services / TTV/ VOIP
NON-Applicable Products Calling Card / IP Applications / Long Distance
Trigger Customer Request for services outlined under applicable products
Pre-Conditions Partial or full address info has been entered by CSR into the Service Address
Service Web App.
Post-Conditions Either an exact match or a set of possible matches is returned to the Service
Address Web App.
Source System Service Address Web App
Target System FMS Adapter
Protocol Remote EJB call to Service Address Service (SAS) EJB
Remote EJB Call from SAS to FMS Adapter
ITOC (IMS Connect) from FMS Adapter to MegaTran
IMS from MegaTran to FMS
Interface Type Synchronous
Response Requirements Synchronous
Development Required Complete.
Consumer of Service Compass SDSE
4.2.1 Description
A user will enter address information that will be processed by OMS. OMS will submit a request to the Service
Address Service to retrieve the address that matches the entered information. Should it not be found, a list of
possible matches will be returned so the user can select the one that matches. Get Service Address shall invoke the
ECCOS address compression table to the address passed from OMS to compress the long address into the
abbreviated short FMS address format. Ref: CR 2682

The See Boxes 1, 2, and 3 within “Select Service Address” section of Master SAD

4.2.2 System Modifications & Enhancements

4.2.3 Error & Exception Handling

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

.ASF Service will be wrapping all exceptions thrown from called systems in AddressSvcException or
InvalidAdressException and will be throwing them to the calling systems. Error logging will be done using
the common framework logging solution
InvalidAddressException
searchServiceAddress in AddressSvc validates Province and City passed from the calling application by
invoking Region Guiding Component in order to check up front whether or not passed data is valid.
Any failure in this call will result in InvalidAdressException to be thrown.
Refer to CR 9276- Region Guiding Error Handling

AddressSvcException
All the other exceptions will be wrapped in AddressSvcException and are thrown back to the calling
system.

4.2.4 Interface Data Elements

Input Data Elements (SearchAddressReqDto)

Field Name Type Length M/O Additional Information
Address (refer to Address M If fmsAddressId is supplied, all other fields are optional.
Appendix A)
If fmsAddressId is not supplied, the following fields are
required:

Required Fields:

Country
Province
City

Fields of Note:

The following if absent will generate “like” returns as

noted in the output elements:
Street – optional
Vector – optional
House Number & Suffix – optional
Apartment – optional

Other fields of note:

AddressType – not currently used. Denotes urban,
rural, civil, legal, lot, block plan, etc.

Address ID should be populated as

FMSREGIONID+FMSADDRESSID (i.e. Without
any Space / separator )

Csr Id String M The CSR / Csr Id – for auditing.

MaxRecordCount Integer M The maximum number of records to return per page.
NextSequenceKey String O This is not an index – it is a key that FMS will use to get
the next n (specified by max record count) records in the
same query. On the first call it does not need to be set –

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Input Data Elements (SearchAddressReqDto)

Field Name Type Length M/O Additional Information
on any further calls, it must be set to the value returned
in the Response sub-object (like streets, like apts, etc,
depending on which one is valid).

There are 4 possible outputs (like streets, like houses, and like apartments, address details).
Output Data Elements (SearchAddressRespDto)
Field Name Type Length M/O Additional Information
Search Address Resp
Dto
Like Streets LikeStreets Returned if a “like streets” match occurs – otherwise it
Dto will be null. Type of return is defined in the “type”
property.
Like Houses LikeHouse Returned if a “like houses” match occurs – otherwise it
sDto will be null. Type of return is defined in the “type”
property.
Like Apartments LikeApart Returned if a “like apts” match occurs – otherwise it will
mentsDto be null. Type of return is defined in the “type” property.
Details ServiceAdd Returned if an exact match occurs – otherwise it will be
ressDetails null. Type of return is defined in the “type” property.
See Appendix A for definition of ServiceAddressDetails.

For SerachServiceAddressforBusinessServices
and GetServiceAddressfor BusinessServices the
Address ID will be Populate as FMS Instance ID +
FMS Address ID.

FMSREGIONID+FMSADDRESSID (i.e. Without

any Space / separator )

Type String Tells you which of the above types was returned by this
search. Enum: LIKE_STREETS; LIKE_APTS;
LIKE_HOUSES; DETAILS.

LikeStreetsDto
Field Name Type Length M/O Additional Information
Address Address The input address that was used as search criteria for this
return. Used so that the web app can maintain state.

Next Sequence Key String The key to use for subsequent calls (to get next pages)
on this query.
Records List A list of LikeStreetsDto.Record objects, defined below.

LikeStreetsDto.Record
Field Name Type Length M/O Additional Information
Street String
Vector String
First House Number String

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

LikeStreetsDto.Record
Field Name Type Length M/O Additional Information
Last House Number String
Treatment Flag String

LikeHousesDto
Field Name Type Length M/O Additional Information
Address Address The input address used for this search.. Used so that the
web app can maintain state.

Next Sequence Key String See above.

Records List A list of LikeHousesDto.Record objects, defined below.

LikeHousesDto.Record
Field Name Type Length M/O Additional Information
House Number String
House Suffix String For duplexes and the like – usually “A” or “B”, etc.

LikeApartmentsDto
Field Name Type Length M/O Additional Information
Address Address The input address used for this search. Used so that the
web app can maintain state.

Next Sequence Key String See above.

Records List A list of LikeApartmentsDto.Record objects, defined
below.

LikeApartmentsDto.Record
Field Name Type Length M/O Additional Information
Apartment String The apartment number.

4.3 Get Service Address Details for Business Services

Event Name Get Service Address Detailsfor BusinessServices (AMDOCS OMS is called
LookupAddress)
Applicable Products Local Line / Internet Services / TTV/ VOIP
NON-Applicable Products Calling Card / IP Applications/ Long Distance
Trigger Request from Amdocs OMS
Pre-Conditions Valid Service Address
Post-Conditions Valid Service Address Details (response from FMS)
Source System(s) Amdocs OMS
Target System FMS
Protocol EJB Remote call from Client to Service Address Service
Interface Type Synchronous
Response Requirements Synchronous
Development Required Complete

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Consumer of Service Compass SDSE

4.3.1 Description
Once a user has a matched service address and/or selects a service address from the OMS system, a request will
retrieve all details pertaining to this address.

See Boxes 1, 2, 3, 4, 5, and 6 within “Provide Address Details” section of Master SAD

4.3.2 System Modifications & Enhancements

A Session Bean will be needed to manage all Service Address business events. A method will be needed to
implement this business event. It will need to communicate to FMS. This is new functionality using transaction
NOI390I and object ‘addrdata’.

4.3.3 Error & Exception Handling

ASF Service will be wrapping all exceptions thrown from called systems in AddressSvcException or
InvalidAdressException and will be throwing them to the calling systems. Error logging will be done using
the common framework logging solution

InvalidAddressException
searchServiceAddress in AddressSvc validates Province and City passed from the calling application by
invoking Region Guiding Component in order to check up front whether or not passed data is valid.
Any failure in this call will result in InvalidAdressException to be thrown.
Refer to CR 9276- Region Guiding Error Handling

AddressSvcException
All the other exceptions will be wrapped in AddressSvcException and are thrown back to the calling
system.

4.3.4 Interface Data Elements

Input Data Elements

Field Name Type Length M/O Additional Information
Csr Id String 8 M CSR ID – x/t-id – CR3696
Address Address M See Appendix A for definition.

Required Fields:

If fmsAddressId is supplied, all other fields are optional,

except:

Province – denotes FMS Region

If fmsAddressId is not supplied, the following fields are

required:

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Input Data Elements

Field Name Type Length M/O Additional Information
Country
Province
City
Street
Vector
House Number & suffix
Apartment – required if the unit is an apartment.

Address ID should be populated as

FMSREGIONID+FMSADDRESSID (i.e. Without
any Space / separator ) – AB/BC+Address id

Output Data Elements (GetAddressDetailsRespDto)

Field Name Type Length M/O Additional Information
Service Address Details ServiceAdd See Appendix A.
ressDetails
For SerachServiceAddressforBusinessServices and
GetServiceAddressfor BusinessServices the Address ID
will be Populate as FMS Instance ID + FMS Address ID.

FMSREGIONID+FMSADDRESSID (i.e. Without

any Space / separator )

4.4 Complete Partial Address (was previous Resolve Service Address)

Event Name Complete Partial Address

Applicable Products Local Line / Long Distance / Internet Services / TTV
NON-Applicable Products Calling Card / IP Applications / VOIP / Transfer of Calls / CPE
Trigger OMS Request to resolve Service Address
Pre-Conditions CSR has indicated in the OMS “Negotiate Installation Address” Activity that the
address in the service address search is what she wants to use, even though it
does not exist in FMS, and therefore needs to be manually resolved.
Post-Conditions Request is acknowledged, indicating address is under investigation by the Service
Address Control Group team.
Source System(s) Amdocs OMS
Target System NetCracker
Protocol EJB Remote Calls
Interface Type Asynchronous
Response Requirements Asynchronous – NetCracker workflow will send a message when the manual
resolution is complete.
Development Required New interface
Consumer of Service Compass Consumer and DT1 Consumer

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

4.4.1 Description

When a CSR wants to identify a partial address, it can send a request to ASF for manual resolution by the service
address control group.

See Boxes 6, 7, and 8 within “Resolve Address Discrepancy” section of Master SAD
4.4.2 System Modifications & Enhancements
A new session bean will be needed to manage all Service Address business events. A method will be needed to
implement this business event. NetCracker will need to have the workflow solution for service address control group
staff to work on this situation.
4.4.3 Error & Exception Handling
Refer to Design Doc: AP475 ASF Services Component Design
4.4.4 Interface Data Elements
Input Data Elements
Field Name Type Length M/O Additional Information
Address Address M User at GUI level is to provide as much info as possible
– usually all criteria entered at service address search.

 See Appendix A
Due date date M
Class of Service ClassOfSer M R – Residence; B – Business
viceType
Customer Customer M Consist of customer’s firstname, lastname, language,
title and customer id.
Customer Contact Array of M Customer contact Information
CustomerC
ontact
Remarks Remarks
Order Action Reference String M This is an async return from NetCracker – the order
Number action reference number is used to correlate the async
return with the original AMDOCS OMS request.
Csr Id String M The CSRs ID.
Legal Land Description String O Legal land description can be used to further narrow
the manual search. (Lot, block plan, etc for rural
addresses).

NOTE: There is no output defined for this method. The OMS connector will return an “AK” (acknowledged) status
back to AMDOCS OMS after the method has successfully executed.

4.5 Get Service Address Details

Event Name Get Service Address Details (AMDOCS OMS is called LookupAddress)
Applicable Products Local Line / Internet Services / TTV/ VOIP
NON-Applicable Products Calling Card / IP Applications/ Long Distance
Trigger Request from Amdocs OMS
Pre-Conditions Valid Service Address

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Post-Conditions Valid Service Address Details (response from FMS)

Source System(s) Amdocs OMS
Target System FMS
Protocol EJB Remote call from Client to Service Address Service
Interface Type Synchronous
Response Requirements Synchronous
Development Required Complete
4.5.1 Description
Once a user has a matched service address and/or selects a service address from the OMS system, a request will
retrieve all details pertaining to this address.

See Boxes 1, 2, 3, 4, 5, and 6 within “Provide Address Details” section of Master SAD

4.5.2 System Modifications & Enhancements

A Session Bean will be needed to manage all Service Address business events. A method will be needed to
implement this business event. It will need to communicate to FMS. This is new functionality using transaction
NOI390I and object ‘addrdata’.

4.5.3 Error & Exception Handling

Refer to Design Doc: AP475 ASF Services Component Design

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

4.5.4 Interface Data Elements

Input Data Elements

Field Name Type Length M/O Additional Information
Csr Id String 8 M CSR ID – x/t-id – CR3696
Address Address M See Appendix A for definition.

Required Fields:

If fmsAddressId is supplied, all other fields are optional,

except:

Province – denotes FMS Region

If fmsAddressId is not supplied, the following fields are

required:

Country
Province
City
Street
Vector
House Number & suffix
Apartment – required if the unit is an apartment.

Output Data Elements (GetAddressDetailsRespDto)

Field Name Type Length M/O Additional Information
Service Address Details ServiceAdd See Appendix A.
ressDetails

4.6 Complete Partial Address (was previous Resolve Service Address)

Event Name Complete Partial Address

Applicable Products Local Line / Long Distance / Internet Services / TTV
NON-Applicable Products Calling Card / IP Applications / VOIP / Transfer of Calls / CPE
Trigger OMS Request to resolve Service Address
Pre-Conditions CSR has indicated in the OMS “Negotiate Installation Address” Activity that the
address in the service address search is what she wants to use, even though it
does not exist in FMS, and therefore needs to be manually resolved.
Post-Conditions Request is acknowledged, indicating address is under investigation by the Service
Address Control Group team.
Source System(s) Amdocs OMS
Target System NetCracker
Protocol EJB Remote Calls

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Interface Type Asynchronous

Response Requirements Asynchronous – NetCracker workflow will send a message when the manual
resolution is complete.
Development Required New interface
4.6.1 Description

When a CSR wants to identify a partial address, it can send a request to ASF for manual resolution by the service
address control group.

See Boxes 6, 7, and 8 within “Resolve Address Discrepancy” section of Master SAD
4.6.2 System Modifications & Enhancements
A new session bean will be needed to manage all Service Address business events. A method will be needed to
implement this business event. NetCracker will need to have the workflow solution for service address control group
staff to work on this situation.
4.6.3 Error & Exception Handling
Refer to Design Doc: AP475 ASF Services Component Design
4.6.4 Interface Data Elements
Input Data Elements
Field Name Type Length M/O Additional Information
Address Address M User at GUI level is to provide as much info as possible
– usually all criteria entered at service address search.

 See Appendix A
Due date date M
Class of Service ClassOfSer M R – Residence; B – Business
viceType
Customer Customer M Consist of customer’s firstname, lastname, language,
title and customer id.
Customer Contact Array of M Customer contact Information
CustomerC
ontact
Remarks Remarks
Order Action Reference String M This is an async return from NetCracker – the order
Number action reference number is used to correlate the async
return with the original AMDOCS OMS request.
Csr Id String M The CSRs ID.
Legal Land Description String O Legal land description can be used to further narrow
the manual search. (Lot, block plan, etc for rural
addresses).

NOTE: There is no output defined for this method. The OMS connector will return an “AK” (acknowledged) status
back to AMDOCS OMS after the method has successfully executed.

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

4.7 Get Clearance Paths

Event Name Get Clearance Path Details For Service Address

Applicable Products Local Line / Internet Services / TTV
NON-Applicable Products Calling Card / IP Applications / VOIP/ Long Distance /CPE / Transfer of Calls
Trigger OMS request for Clearance Paths Automatic Trigger from OMS at the start of
handle clearance activity.
Pre-Conditions Negotiate Service Address has completed successfully and a valid Address is
available to send to this service.
Post-Conditions clearance path details for Valid Service Address
Source System(s) Amdocs OMS S2S
Target System Service Address Service (ASF)
Protocol EJB from Client to Service Address Service
Interface Type Synchronous
Response Requirements Synchronous
Development Required New Interface: Amdocs OMS to Service Address Service to FMS
4.7.1 Description

OMS requests for the available clearance paths for a service address.

See Boxes 1, 2, 3, 4, and 5 within “Clearance Path” section of Master SAD

4.7.2 System Modifications & Enhancements

A new Session Bean will be needed to manage all Service Address business events. A method will be needed to
implement this business event. It will need to communicate to FMS. This is new functionality available by using
transaction NOI390I and object ‘addrserv’. A new field RIT (Recommended Install Type) is required for every
clearance path returned.
** NOTE: Clearance paths will be sorted according to TD 2976
4.7.3 Error & Exception Handling
See Design Doc.

4.7.4 Interface Data Elements

Input Data Elements

Field Name Type Length M/O Additional Information
Address Address M Required Fields:

CO ID
Province – denotes the province at which the
service is provided – assert not null.
City – denotes the city at which the service is
provided – assert not null.
ServiceAddressID- FMS address Id
See Appendix A for object def.
Csr ID String 8 M CSR ID – x/t-id – CR3696

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Input Data Elements

Field Name Type Length M/O Additional Information
ProductServiceType String 5 O Possible values are
SL-Single Line
TTV- Telus TV
HS-High Speed Internet
null –If product is not present

Output Data Elements. (ClearancePaths) up to 420 paths

Field Name Type Length M/O Additional Information
Service Path ID String 20 M Primary key for a Service Path/Clearance Path.

Primary TN String 28 (to O The TN or circuit number at the address (whether

be working or not).
verified
) FMS currently filters paths without a valid TN or
circuit number, but that filter is being removed.
TN may or may not be a working number.

This field must be displayed in OMS.

Additional TN String 10 O
Customer TN String 10 O
Customer Name String 65 O Telus Service will need to concat the Customer
Name #1,2,3 from CRIS with a space between the
fields.

Service type code String 3 M From FMS. Also called “Line Type Code” –
indicates what kind of line was working on this
service path. Three character code. Will be passed
as-is from FMS.

A type code description is also available in FMS,

which can be passed as well, if desired.

Required for ETTS/GPON (DT1 needs to know if

path is ETTS or GPON –Defect 54509)
Clearance Date String 8 O From FMS “Due date” field. Last date something
was done on the path, as an indicator of how old
the path is. Currently displayed.

The agent uses this to determine which path had

the most recent activity.

For Pending orders on ETTS/GPON address, Due

Date of Order will be set in this field.
Party position number String 2 O If a party line, indicates which party number this
telephone number is. Returned, but OMS

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Output Data Elements. (ClearancePaths) up to 420 paths

Field Name Type Length M/O Additional Information
connector will likely filter it out.

Not Required for ETTS/GPON

SVP status code String 1 M Service Path Status Code – whether the path is W-
working, N-non-working, I-pending in, O-pending
out, Z- Express dialtone. In old stack, this value is
translated into a Line Status description by
ECCOS. Z will be displayed the same as status
code N within OMS.

OMS will translate/globalize into a description for

display.
Tel circt flag String 1 M indicates whether the return value for the message
is a TN or a Circuit number.

Always T for ETTS/GPON

CP DP code String 1 M Cable Pair Dedicated Plant code. Line designation.
Currently translated by ECCOS. In New Stack, they
will be translated/globalized by OMS.
[D OMS translates to Primary
,N,Y OMS translates to secondary]

Required for DV
Switch type code String 2 O From FMS. Persisted in OMS only for the life of the
order, and will be passed back to ASF in the Get
Provisioning Requirements interface.

Not Required for ETTS/GPON

Connected Status String 4 O This is a new field to be added to the FMS
interface. From RIT – Recommended Install Type.
Persisted in OMS only for the life of the order.
Stored in OMS field “Connected Status”.
See appendix A.5 for list of values.
Will come back thru the PTR.

Not Required for ETTS/GPON

Leased Loop Flag String 1 M This is a new field to be added to the FMS interface
Indicates whether the path is a leased loop or not.
If Y and working, it is leased to someone else. If Y
and non-working, it was leased in the past but is no
available for use again. [Y/N]

Always N for ETTS/GPON

NonPub Indicator String 1 O From FMS. Customer name is or is not published in
the directory and name display.
Blank published Should not display in OMS
N non-published – charge Will be displayed in OMS
P non-post – does not charge
if N or P Will be displayed in OMS as NP.

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Output Data Elements. (ClearancePaths) up to 420 paths

Field Name Type Length M/O Additional Information

Always N for ETTS/GPON

High Speed Warm String 1 C A ‘Y‘ will be populated in this field, if the clearance
Home Indicator path has a usable ‘DSL‘ port and ‘N’ will be
populated otherwise.

Not Required for ETTS/GPON

5 Service Availability Service Business Events

5.1 Service Availability Check By Service Address

Event Name Service Availability Check By Service Address

Applicable Products Internet Services / TTV (SD & HD)
NON-Applicable Products Single Line features, VOIP, LD, Calling Card, etc.
Trigger Request from CSR Web Portal, Self Serve Portal, IVR, or Service
Configuration Service for a ADSL/TTV Service Availability Check.
Pre-Conditions Service Address of the target service should have been
determined.
Telus Service Availability Service is available to handle next
request.
Post-Conditions ADSL and TTV qualification information returned to Telus Service
Availability Service.
Source System(s) DT1
Target System ASF
Protocol RMI/IIOP/EJB
Interface Type Synchronous
Development Required Update ASF program logic
5.1.1 Description
During pre-order, either
1) The Portals request a Service Availability Check by Service Address for a Service Location .
2) Only consumer tiers will be returned.

NOTE: This Business Event corresponds to boxes 1-5 of “Pre-order Service Availability Check”
section of Master SAD.

5.1.2 System Modifications & Enhancements

Update ASF program logic to calls TOGW Qual with a list of consumer tiers to be qualified. The consumer
tiers names have to be mapped to the corresponding TOGW qualifier names first before passing to
TOGW. TOGW then sends back response of list of qualifier name / qualifier value pairs. ASF then maps
the qualifier names back to consumer tier names and passes back result to DT1. The mapping table for
mapping between consumer tiers and TOGW qualifier names is as follows:

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Ordered Product Consumer TOGW Qualifier Name

Tier 
TELUS TV SDTV TTV_SD_ABBC
High Definition TTV HDTV TTV_HD_ABBC
High Speed Lite HS128 HSIA_ALL_ABBC
High Speed Internet HSR HSIA_ALL_ABBC
High Speed Extreme HSU HSIA_6_ABBC
High Speed Enhanced HSEV HSIA_3_CONS_ABBC
(v1)
TELUS High Speed THS HSIA_ALL_ABBC
High Speed Enhanced HSE HSIA_ALL_ABBC
Home Networking HN HNS HSIA_ALL_ABBC
High Speed Enhanced HSEG HSIA_ALL_ABBC
(Grandfathered)
TELUS High Speed 15 HSEXL HSIA_15_CONS_ABBC

TELUS High Speed 25 HSSP NA

TELUS High Speed 0 HSZERO TTV_HSIA_19_ABBC
Flex
TELUS High Speed 15 HSEXLF TTV_HSIA_19_ABBC
Flex
TELUS High Speeed 25 HSSPF TTV_HSIA_19_ABBC
Flex
Telus TV Mediaroom TV19 TTV_HSIA_19_ABBC

Note: First column is used as a description.

Since TOGW is not able to qualify “TELUS High Speed 25” yet, so this product will not be sent down to
TOGW. Instead, ASF Services will always return qualifying status of “DQN” on High Speed 25 for non-
ETTS/non-GPON location.
(Per Kalpesh's ask: Since TOGW is not able to qualify “TELUS High Speed 25” yet, so this product will
not be sent down to TOGW. Instead, ASF Services will always return qualifying status of “DQN” on High
Speed 25 for non-ETTS/non-GPON location. Once TOGW completes implementation of " HS 25"
functionality, ASF Services needs to be updated to remove the hard coded "DQN" and make the
appropriate call to TOGW.)

5.1.3 Error & Exception Handling

Should an error occur, the method should return a java exception and the calling program can handle
it. The method should use the common framework logging solution to send the error somewhere it
can be handled by the systems operation group.

5.1.4 Interface Data Elements

Input Data Elements
Field Name Type Length M/O Additional Information
ServiceAddress Object M The Object containing all Address and Address Detail
Information.
STREET VARCHAR2(18)
VECTOR VARCHAR2(2)

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Input Data Elements

Field Name Type Length M/O Additional Information
HOUSE_NUMBER VARCHAR2(5)
HOUSE_SUFFIX VARCHAR2(1)
APARTMENT_NUMBER VARCHAR2(5)
CITY VARCHAR2(19)
PROVINCE VARCHAR2(2)
POSTAL_CODE VARCHAR2(6)
SERVICEADDRESSID VARCHAR2
Only required if a valid telephone number isn’t present.
Both the Telephone Number and Service Address must
not be entered.

There is a need to construct a String for the Valid

Service Address for the ODS and Service Address
Control.

Output Data Elements - Successful

Field Name Type Length M/O Additional Information
ProductQualifierRespDto DTO M This DTO will have following fields

Output Data Elements - Successful

ProductQualifierRespDto
Field Name Type Length M/O Additional Information
ProductQualifier Array M This array will have the qualifier name and qualifier
value
turboFlag Boolean M True if address is ETTS/GPON else False
changeOfTechnologyFlag Boolean M True if change of technology has occurred on this
address else False

ProductQualifier Array
Field Name Type Length M/O Additional Information
List of key value pairs
qualifierName String Var M Possible values:
SDTV
HDTV
HS128
HSR
HSU
HSEV
THS
HSE
HNS
HSEG
HSEXL( HSIA 15)
HSSP (HSIA 25)
qualifierValue String Var M List will have one of the following Qualifier (Reason)
Codes:
QUA = Qualifies

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

DQN = Does Not Qualify – No Override

DQO = Does Not Qualify – Override
UND = Undetermined

5.1.5 Sample Event

Sample message – standard java format expected.

5.2 Service Availability Check By Telephone Number

Event Name Service Availability Check By Telephone Number

Applicable Products Internet Services / TTV (SD & HD)
NON-Applicable Products Single Line features, VOIP, LD, Calling Card, etc.
Trigger Request from CSR Web Portal, Self Serve Portal, IVR, or Service
Configuration Service for a ADSL/TTV Service Availability Check.
Pre-Conditions Telephone Number of the target service should have been
determined.
Telus Service Availability Service is available to handle next
request.
Post-Conditions ADSL and TTV qualification information returned to Telus Service
Availability Service.
Source System(s) Vesta
Target System ASF
Protocol RMI/IIOP/EJB
Interface Type Synchronous
Development Required Update ASF program logic

5.2.1 Description
During pre-order, either
1) The Portals or IVR requests a Service Availability Check for a telephone number.
2) Only consumer tiers will be returned.

NOTE: This Business Event corresponds to boxes 1-5 of “Pre-order Service Availability Check”
section of Master SAD.

5.2.2 System Modifications & Enhancements

Update ASF program logic to calls Qual with a list of consumer tiers to be qualified. The consumer tiers
names have to be mapped to the corresponding TOGW qualifier names first before passing to TOGW.
TOGW then sends back response of list of qualifier name / qualifier value pairs. ASF then maps the
qualifier names back to consumer tier names and passes back result to Ordering. The mapping table for
mapping between consumer tiers and TOGW qualifier names is as follows:

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Ordered Product Consumer TOGW Qualifier Name

Tier 
TELUS TV SDTV TTV_SD_ABBC
High Definition TTV HDTV TTV_HD_ABBC
High Speed Lite HS128 HSIA_ALL_ABBC
High Speed Internet HSR HSIA_ALL_ABBC
High Speed Extreme HSU HSIA_6_ABBC
High Speed Enhanced HSEV HSIA_3_CONS_ABBC
(v1)
TELUS High Speed THS HSIA_ALL_ABBC
High Speed Enhanced HSE HSIA_ALL_ABBC
Home Networking HN HNS HSIA_ALL_ABBC
High Speed Enhanced HSEG HSIA_ALL_ABBC
(Grandfathered)
TELUS High Speed HSEXL HSIA_15_CONS_ABBC
15
TELUS High Speed HSSP NA
25
TELUS High Speed 0 HSZERO TTV_HSIA_19_ABBC
Flex
TELUS High Speed 15 HSEXLF TTV_HSIA_19_ABBC
Flex
TELUS High Speeed 25 HSSPF TTV_HSIA_19_ABBC
Flex
Telus TV Mediaroom TV19 TTV_HSIA_19_ABBC

Note: First column is used as a description.

Since TOGW is not able to qualify “TELUS High Speed 25” yet, so this product will not be sent down to
TOGW. Instead, ASF Services will always return qualifying status of “DQN” on High Speed 25 for non-
ETTS/non-GPON location.

(Per Kalpesh's ask: Since TOGW is not able to qualify “TELUS High Speed 25” yet, so this product will
not be sent down to TOGW. Instead, ASF Services will always return qualifying status of “DQN” on High
Speed 25 for non-ETTS/non-GPON location. Once TOGW completes implementation of " HS 25"
functionality, ASF Services needs to be updated to remove the hard coded "DQN" and make the
appropriate call to TOGW.)

5.2.3 Error & Exception Handling

Should an error occur, the method should return a java exception and the calling program can handle it.
The method should use the common framework logging solution to send the error somewhere it can be
handled by the systems operation group.

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

5.2.4 Interface Data Elements

Input Data Elements

Field Name Type Length M/O Additional Information
TelephoneNumber Object M It has following fields-
Npa m_npa
String m_nxx
String m_line
String m_releaseDate

Output Data Elements - Successful

Field Name Type Length M/O Additional Information
ProductQualifierRespDto DTO M This DTO will have following fields

Output Data Elements - Successful

ProductQualifierRespDto
Field Name Type Length M/O Additional Information
ProductQualifier Array 5 M This array will have the qualifier name and qualifier
value
turboFlag Boolean M True if TN is of ETTS/GPON location else False
changeOfTechnologyFlag Boolean M True if change of technology has occurred on this
address else False

ProductQualifier
Field Name Type Length M/O Additional Information
List of Key Value Pairs
qualifierName String Var M Possible values:
SDTV
HDTV
HS128
HSR
HSU
HSEV
THS
HSE
HNS
HSEG
HSEXL( HSIA 15)
HSSP (HSIA 25)
qualifierValue String Var M List will have one of the following Qualifier (Reason)
Codes:
QUA = Qualifies
DQN = Does Not Qualify – No Override
DQO = Does Not Qualify – Override
UND = Undetermined

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

5.2.5 Sample Event

Sample message – standard java format expected.

5.3 Loop Qualification By Address

Event Name Loop Qualification By Address

Applicable Products Internet Services / TTV (SD & HD)
NON-Applicable Products Single Line features, VOIP, LD, Calling Card, etc.
Trigger AMDOCS OMS request for line capabilities
Pre-Conditions Service Address from primary service location exists
Post-Conditions Loop Qualification returned to OMS
Source System(s) OMS
Target System ASF
Protocol EJB/RMI/IIOP
Interface Type Synchronous
Development Required Modify ASF Interface to allow passing of Service Tier as parameter

5.3.1 Description

Ordering will request loop qualifications from the Service Availability ODS through the ASF Telus Service
and Netcracker

OK: This is basically the same call as Service Availability Check, except that it returns more detail. (line
speed, etc.)

5.3.2 System Modifications & Enhancements

ASF will call NetCracker LoopQualByServiceAddress method and get qual result from NetCracker to be
returned to ASF to OP and then to OMS.

In addition to service address, service tier name to be qualified will be passed in from OP. NetCracker will
map the service tier name to the corresponding TOGW qualifier names first before passing to TOGW for
qualification. The mapping table for mapping between service tier and TOGW qualifier names is as
follows:

Ordered Product Services Tier TOGW Qualifier Name

 
TELUS TV SDTV TTV_SD_ABBC
High Definition TTV HDTV TTV_HD_ABBC
High Speed Lite HS128 HSIA_ALL_ABBC
High Speed Internet HSR HSIA_ALL_ABBC
High Speed Extreme HSU HSIA_6_ABBC

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Ordered Product Services Tier TOGW Qualifier Name

 
High Speed Enhanced HSEV HSIA_3_CONS_ABBC
(v1)
TELUS High Speed THS HSIA_ALL_ABBC
High Speed Enhanced HSE HSIA_ALL_ABBC
Home Networking HN HNS HSIA_ALL_ABBC
High Speed Office HSOF HSIA_ALL_ABBC
High Speed Office 5IP HSO5IP HSIA_ALL_ABBC
High Speed Server HSSB HSIA_ALL_ABBC
High Speed Server HSSB4 HSIA_ALL_ABBC
Enhanced
High Speed Enhanced HSEG HSIA_ALL_ABBC
(Grandfathered)
TELUS High Speed HSEXL HSIA_15_CONS_ABBC
15
TELUS High Speed HSSP NA
25
TELUS High Speed 0 HSZERO TTV_HSIA_19_ABBC
Flex
TELUS High Speed 15 HSEXLF TTV_HSIA_19_ABBC
Flex
TELUS High Speeed 25 HSSPF TTV_HSIA_19_ABBC
Flex
Telus TV Mediaroom TV19 TTV_HSIA_19_ABBC

Note: First column is used as a description.

5.3.3 Error & Exception Handling

See Design Doc
5.3.4 Interface Data Elements

Input Data Elements

Field Name Type Length M/O Additional Information
Service Address OBJ M The Object containing all Address and Address Detail
Information.:
STREET VARCHAR2(18)
VECTOR VARCHAR2(2)
HOUSE_NUMBER VARCHAR2(5)
HOUSE_SUFFIX VARCHAR2(1)
APARTMENT_NUMBER VARCHAR2(5)
CITY VARCHAR2(19)
PROVINCE VARCHAR2(2)
POSTAL_CODE VARCHAR2(6)
SERVICEADDRESSID VARCHAR2

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Input Data Elements

Field Name Type Length M/O Additional Information
Only required if a valid telephone number isn’t present.
Both the Telephone Number and Service Address must
not be entered.

There is a need to construct a String for the Valid

Service Address for the ODS and Service Address
Control.
ServiceTier String 10 M Possible values:
SDTV
HDTV
HS128
HSR
HSU
HSEV
THS
HSE
HNS
HSOF
HSO5IP
HSSB
HSSB4
HSEG
HSEXL( HSIA 15)
HSSP (HSIA 25)

Output Data Elements - Successful

Field Name Type Length M/O Additional Information
LoopQualTiersRespDto DTO M This DTO will have loop qual response, CLLI and
theoretical bandwidth

LoopQualTiersRespDto
Field Name Type Length M/O Additional Information
qualifierValue String Var M List will have one of the following Qualifier (Reason)
Codes:
QUA = Qualifies
DQN = Does Not Qualify – No Override
DQO = Does Not Qualify – Override
UND = Undertermined
CLLI Code AN 12 O CO CLLI or ERA CLLI
Theoretical Bandwidth String O Theoretical bandwidth associated to a circuit based on
the records in IMAGE and FMS for that circuit.
(converted from float - million bits per second)
Theoretical Bandwidth for ETTS-100
Theoretical Bandwidth for GPON- 80

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

5.3.5 Sample Event

Sample message – standard java format expected.

5.4 Loop Qualification By Telephone Number

Event Name Loop Qualification By Telephone Number

Applicable Products Internet Services / TTV (SD & HD)
NON-Applicable Products Single Line features, VOIP, LD, Calling Card, etc.
Trigger AMDOCS OMS request for line capabilities
Pre-Conditions Telehone Number for primary service location exists
Post-Conditions Loop Qualification returned to OMS
Source System(s) IVR
Target System ASF
Protocol EJB/RMI/IIOP
Interface Type Synchronous
Development Required Modify ASF Interface to take TN as additional parameter

5.4.1 Description

IVR will request loop qualifications from the Service Availability ODS through the Service Availability
Service.

OK: This is basically the same call as Service Availability Check, except that it returns more detail. (line
speed, etc.)

5.4.2 System Modifications & Enhancements

ASF will call NetCracker LoopQualByTN method and get qual result from NetCracker to be returned to
Ordering.

In addition to service address, service tier name to be qualified will be passed in from IVR. NetCracker will
map the service tier name to the corresponding TOGW qualifier names first before passing to TOGW for
qualification. The mapping table for mapping between service tier and TOGW qualifier names is as
follows:

Ordered Product Services Tier TOGW Qualifier Name

 
TELUS TV SDTV TTV_SD_ABBC
High Definition TTV HDTV TTV_HD_ABBC
High Speed Lite HS128 HSIA_ALL_ABBC
High Speed Internet HSR HSIA_ALL_ABBC
High Speed Extreme HSU HSIA_6_ABBC
High Speed Enhanced (v1) HSEV HSIA_3_CONS_ABBC
TELUS High Speed THS HSIA_ALL_ABBC
High Speed Enhanced HSE HSIA_ALL_ABBC

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Ordered Product Services Tier TOGW Qualifier Name

 
Home Networking HN HNS HSIA_ALL_ABBC
High Speed Office HSOF HSIA_ALL_ABBC
High Speed Office 5IP HSO5IP HSIA_ALL_ABBC
High Speed Server HSSB HSIA_ALL_ABBC
High Speed Server HSSB4 HSIA_ALL_ABBC
Enhanced
High Speed Enhanced HSEG HSIA_ALL_ABBC
(Grandfathered)
TELUS High Speed HSEXL HSIA_15_CONS_ABBC
15
TELUS High Speed HSSP NA
25
TELUS High Speed 0 Flex HSZERO TTV_HSIA_19_ABBC
TELUS High Speed 15 HSEXLF TTV_HSIA_19_ABBC
Flex
TELUS High Speeed 25 HSSPF TTV_HSIA_19_ABBC
Flex
Telus TV Mediaroom TV19 TTV_HSIA_19_ABBC

Note: First column is used as a description.

5.4.3 Error & Exception Handling

See Design Doc
5.4.4 Interface Data Elements

Input Data Elements

Field Name Type Length M/O Additional Information
TelephoneNumber Object M It has following fields-
Npa m_npa
String m_nxx
String m_line
String m_releaseDate
ServiceTier String 10 M Possible values:
SDTV
HDTV
HS128
HSR
HSU
HSEV
THS
HSE

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Input Data Elements

Field Name Type Length M/O Additional Information
HNS
HSOF
HSO5IP
HSSB
HSSB4
HSEG
HSEXL( HSIA 15)
HSSP (HSIA 25)

Output Data Elements - Successful

Field Name Type Length M/O Additional Information
LoopQualTiersRespDto DTO M This DTO will have loop qual response, CLLI and
theoretical bandwidth

LoopQualTiersRespDto
Field Name Type Length M/O Additional Information
qualifierValue String Var M List will have one of the following Qualifier (Reason)
Codes:
QUA = Qualifies
DQN = Does Not Qualify – No Override
DQO = Does Not Qualify – Override
UND = Undertermined
CLLI Code AN 12 O CO CLLI or ERA CLLI
For ETTS/GPON location, CLLI will have dummy
value
Theoretical Bandwidth String O Theoretical bandwidth associated to a circuit based on
the records in IMAGE and FMS for that circuit.
(converted from float - million bits per second)
Theoretical Bandwidth for ETTS-100
Theoretical Bandwidth for GPON- 80

5.4.5 Sample Event

Sample message – standard java format expected.

5.5 Get Calling Features

Event Name Get Eligible Features

Applicable Products Single Line
Trigger Amdocs OMS request for eligible POTS features, Negotiate Product Config
Pre-Conditions Amdocs requires eligible POTS features for a service address, class and type;
Connector populates CO ID and Province fields in input Address object.
Post-Conditions Amdocs receives all eligible POTS features for a service address
Source System(s) Amdocs OMS S2S
Target System NetCracker / FMS

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Protocol EJB/RMI/IIOP
Interface Type Synchronous
Response Requirements Synchronous
Development Required New Interface: Amdocs OMS to Service Availability Service to NetCracker
5.5.1 Description
OMS requests a list of features for a service address, class and type.

See Boxes 6, 7, 8, 9, and 10 within “Determine Eligibility” section of Master SAD

5.5.2 System Modifications & Enhancements

A new session bean will be needed to manage all Service Availability requests. A method will be needed to
implement this business event. It will have to communicate to FMS to retrieve the information.

5.5.3 Error & Exception Handling

ASF Service will be wrapping all exceptions thrown from called systems in AvailabilitySvcException or
InvalidAdressException and will be throwing them to the calling systems. Error logging will be done using
the common framework logging solution
5.5.4 Interface Data Elements

Input Elements
Field Name Type Length M/O Additional Information
Address Address M Required Fields:

CO ID- assert not null

Province – denotes FMS Region –
assert not null

The following fields are required if

the address is not new or
overridden by CSR:
fmsAddressId,
city

Resource ID String C Required to differentiate service

path type (DV or Copper), when
Order Action Type is “Change”,
“Change Ownership”, or “Resume”

The source is the OMS resource ID

Order Action Type String 2 C Required to differentiate service
(See path type (DV or Copper); e.g.
Append “PR”, “CH”; all order action types
ix A7 other than "Change" "Change

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Input Elements
Field Name Type Length M/O Additional Information
for Ownership", “Change Installation
LOV) Address”, "Resume" shall be
treated the same as "Provide",
including blank value.

Csr Id String M CSR ID – x/t-id – CR3696

ServiceClass String M FMS Class of Service (‘B’ –
Business, ‘R’ – Residential)

ServiceType String M FMS Service Type of Product

(“IND”, “OVL”)

Output Data Elements

Field Name Type Length M/O Additional Information
Collection of Feature Codes Collection 0..n M Will be returned based on
(Strings) NetCracker translation between
FMS Feature IDs cross referenced
with OMS Feature codes

5.6 Validate Configuration: Single Local Line (was Validate Mutually Exclusive
Features)

Event Name Validate Mutually Exclusive Features (changed to: Validate Configuration:
Single Local Line)
Applicable Products Single Local Line
Trigger Amdocs OMS request for validation of product & features, Negotiate Product
Configuration after the product information has been entered.
Pre-Conditions Amdocs OMS receipt of available POTS features from FMS
Post-Conditions Upon validation and reservation of an available port to support that selected
POTS features, the order is ready to begin the “Telephone Number Selection
process”
Source System(s) Amdocs OMS
Target System Service Availability Service / NetCracker / FMS
Protocol EJB/RMI/IIOP
Interface Type Synchronous
Response Requirements Synchronous
Development Required New Interface: Amdocs OMS to Service Availability Service to NetCracker

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

5.6.1 Description
After a user has selected the features for a new OMS order, Netcracker needs to validate the feature selections to
ensure they are all possible. A return code will indicate if the validation is successful or not. Should validation fail, a
list of mismatched feature ids per switch type will be returned back to the calling application.
Critical information are Service Address and ID, CLLI Code selected Features, Service Class, and Service Type,
related product information

Ref: ”Validate Configuration” section of “ASF MM SAD_AddALL_MASTER” SAD.

5.6.2 System Modifications & Enhancements

A new session bean will be needed to manage all Service Availability requests. A method will be needed to
implement this business event. It will have to communicate to Netcracker for processing and FMS to retrieve the
information.

5.6.3 Error & Exception Handling

ASF Service will be wrapping all exceptions thrown from called systems in AvailabilitySvcException or
InvalidAdressException and will be throwing them to the calling systems. Error logging will be done using
the common framework logging solution

5.6.4 Interface Data Elements

Input Elements
Field Name Type Length M/O Additional Information
Address Address M For SL, required Address fields
are:
CO ID – assert not null
Province – denotes FMS region to
query – assert not null

The following fields are required if

the address is not new or
overridden by CSR:
fmsAddressId,
city

Single Line Product Array of features M AMDOCS Single Line Product

object.
Resource ID String C Required to differentiate service
path type (DV or Copper), when
Order Action Type is “Change”,
“Change Ownership”, or “Resume”

The source is the OMS resource ID

Order Action Type String 2 C Required to differentiate service

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Input Elements
Field Name Type Length M/O Additional Information
(See path type (DV or Copper); e.g.
Append “PR”, “CH”; all order action types
ix A7 other than "Change" "Change
for Ownership", “Change Installation
LOV) Address”, "Resume" shall be
treated the same as "Provide",
including blank value.

Csr id String M For auditing.

ServiceClass String M FMS Class of Service (‘B’ –
Business, ‘R’ – Residential)

ServiceType String M FMS Service Type of Product

(“IND”, “OVL”)

Output Data Elements

Field Name Type Length M/O Additional Information
Features Collection 0…n M A collection of feature incompatibilities, defined
Incompatibilities of below.
FeaturesInc
ompatibilit
y objects.

FeaturesIncompatability Object
Switch ID String M Swu – identifies the switch for which we are describing
available / unavailable features.
Collection of available Collection 0..n Available features for this switch.
features of Strings
Collection of non- Collection 0..n Non-available features for this switch.
available features of Strings

5.7 Check line Portability by Address

Event Name Single Line Portability and PIC-ability Check

Applicable Products Single Line
Trigger OMS request for portability and PIC-ability during the negotiate product config.
Pre-Conditions Telephone is brought forward from ‘outward’ address or existing service,
installation address has been the negotiated
Post-Conditions Results from TN portability and PIC-ability check against the service address
Source System(s) Amdocs OMS S2S
Target System NetCracker / FMS
Protocol EJB

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Interface Type Synchronous

Response Requirements Synchronous
Development Required New Interface: Amdocs OMS to Service Availability Service to NetCracker
5.7.1 Description
See the Single Line Portability.

5.7.2 System Modifications & Enhancements

A new session bean will be needed to manage all Telephone Service requests. A method will be needed to
implement this business event. It will have to communicate to Netcracker and FMS to retrieve the information.

5.7.3 Error & Exception Handling

See Design Doc.
5.7.4 Interface Data Elements

Input Data Elements

Field Name Type Length M/O Additional Information
Address Address M Province – assert not null – Province
where the service is provided.
City – assert not null. - City where the
service is provided.

Telephone Number Telephone 10 M

Number
Csr Id String M CSR ID – x/t-id – CR3696

Output Data Elements

Field Name Type Length M/O Additional Information
PortabilityResult Class
TELUS NPA / NXX Boole M
an
Portable Boole M True if portable
an
Port Local Routing Number (LRN) String M Local Routing Number
Previous Local Service Provider Required Boole M True if the previous number is
an owned by Telus

5.8 PIC-ability Check

Event Name PIC-ability Check

Applicable Products Single Line
Trigger OMS request for PIC-ability during the negotiate product config.
Pre-Conditions Telephone is brought forward from ‘outward’ address or existing service,
installation address has been the negotiated
Post-Conditions Results from PIC-ability check

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Source System(s) OMS

Target System NetCracker
Protocol EJB
Interface Type Synchronous
Response Requirements Synchronous
Development Required Interface refactoring: Amdocs OMS to Service Availability Service to NetCracker

5.8.1 Description
This interface will call Get PIC Code to retrieve the current PIC code to use for the PIC-ability check business event.
The fields required for Get PIC Code can be defaulted or obtained from the parameters being passed into this
business event. The expected behavior is as following:

Order Action Service Current Service Get PIC for Check Result
Type Address Type
Technology
Change Don’t care DV Don’t care False (reason
code: 97)
Change Don’t care copper Existing TN first; copper logic
if not available,
New TN
Provide ETTS/GPON or Don’t care Don’t care False (reason
dual fed code: 97)
Provide Copper Don’t care Existing TN first; Copper logic
if not available,
New TN

5.8.2 System Modifications & Enhancements

A method will be needed to implement this business event. It will have to communicate to Netcracker to retrieve the
information.

5.8.3 Error & Exception Handling

See Design Doc.
5.8.4 Interface Data Elements
Input Data Elements
Field Name Type Length M/O Additional Information
DueDate String 8 M Due date format is: CCYYMMDD.
Service Address Address C Required for DV capable locations.

Required Fields:

CO ID
Province – denotes the province at
which the service is provided – assert
not null.

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Input Data Elements

Field Name Type Length M/O Additional Information
City – denotes the city at which the
service is provided – assert not null.
ServiceAddressID- FMS address Id
See Appendix A for object def.
Order Action Type String 2 C Required for DV capable locations. E.g.
(See “PR”, “CH”
Appendix
A7 for
LOV)
New TN String 10 C The New TN being checked. Required if
LRN is not available.
Existing TN String 10 C Required for Change/Move orders
involving TN change
Local Routing Number String 10 C Local Routing Number, Caller will get
this from FMS service address;
required if New TN is not available
PIC Change Reason Code String 2 M PIC change reason code. This comes from
OMS.

Output Data Elements – PicStatus

Field Name Type Length M/O Additional Information
Picable Boolean M True if picable
Error code String M Error code. If success, it will be 0. else
it will be “E####”.
Error text String M Description of the message. If
success, it will be “success” else
actual error message based on error
code.
Pic reason Code String M Could override input reason code

5.9 GetPicStatus

Event Name GetPicStatus

Applicable Products Single Line , Multiline
Trigger OMS request for PIC Status during the negotiate product config.
Pre-Conditions Telephone is brought forward from ‘outward’ address or existing service,
installation address has been the negotiated
Post-Conditions Results from PIC Status
Source System(s) OMS
Target System PIC Admin Adapter
Protocol EJB
Interface Type Synchronous
Response Requirements Synchronous
Development Required Interface refactoring: Amdocs OMS to Service Availability Service to Pic Admin
Adapter
Consumer Compass SDSE

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

5.9.1 Description
This interface will call the Pic Admin via Pic Adapter to get the respective PIC status (i.e. TELUS / Non
Telus) for the given TNs.
5.9.2 System Modifications & Enhancements
A method will be needed to implement this business event. It will have to communicate to PIC Admin Adapter to
retrieve the information.

5.9.3 Error & Exception Handling

ASF Service will be wrapping all exceptions thrown from called systems in AvailabilitySvcException or
InvalidAdressException and will be throwing them to the calling systems. Error logging will be done using
the common framework logging solution

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

5.9.4 Interface Data Elements

Input Data Elements
Field Name Type Length M/O Additional Information
GetPicStatusRequest[] Array of M This object Contains the below attribute
OBJECT (i.e. Array of Objects)
GetPICSta
tusReques
t
Input Data Elements – GetPicStatusRequest
Field Name Type Length M/O Additional Information
Date String 8 M The date when the PIC information
needs to retrieve
Date format is: CCYYMMDD
Function code String 4 M The search based on input date and
functional search
Applicable search criteria
("LATE", "PREV", "WORK", "FRST")
Billing TN String 10 C Billing TN. For services like over line
product OMS sends BTN. If customer
changes their BTN, BTN should be
old BTN.
Working TN String 10 M Working WTN. If customer changes
their WTN, WTN should be old WTN
not the new WTN.

Outout Data Elements – GetPicStatusResponse

Field Name Type Length M/O Additional Information
GetPicStatusResponse[] Array of M This Object Contains the below
Object attribute (Array of Object)

Outout Data Elements – GetPicStatusResponse

Field Name Type Length M/O Additional Information
Billing TN String 10 C This is same as in Request
Working TN String 10 M This is same as in Request
PicStatus String 10 M This will be status of the PIC.
- ( TELUS or NON-TELUS
Or UNDETERMINED)

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

5.10 Get TN Portability Results by COID and NPA/NXX

Event Name Get TN Portability Results by COID and NPA/NXX

Applicable Products Single Line
Trigger TN Selection Web requests for portability during the negotiate product config
Pre-Conditions Telephone is brought forward from ‘outward’ address or existing service,
installation address has been the negotiated
Post-Conditions Results from TN portability check against the COID and NPA/NXX
Source System(s) TN Selection Web App
Target System NetCracker / FMS
Protocol EJB /RMI/IIOP
Interface Type Synchronous
Response Requirements Synchronous
Development Required New Interface: NetCracker API to Amdocs OMS
5.10.1 Description
When a user moves to a new service address, they may request to keep their old phone number. OMS will request to
see if this number is portable to the new service address location through TN Selection Web app by using COID and
NPA/NXX.

See Boxes 1, 2, and 3 as well as 5, 6 and 7 within “Telephone Number Select” section of Master SAD

5.10.2 System Modifications & Enhancements

A new session bean will be needed to manage all Telephone Service requests. A method will be needed to
implement this business event. It will have to communicate to Netcracker and FMS to retrieve the information.

5.10.3 Error & Exception Handling

Should an error occur, the method should return a java exception and the calling program can handle it. As well, the
method should use the common framework logging solution to send the error somewhere it can be handled by the
systems operation group.
5.10.4 Interface Data Elements

Input Data Elements

Field Name Type Length M/O Additional Information
Service Address Addre M Required Fields:
ss
CO ID – assert not null
Province – denotes FMS Region
to query – assert not null

Appendix A for object definition.

Csr id String M CSR ID – x/t-id – CR3696, for
auditing.
Native NPA / NXX Telep M Contains native npa and nxx to
hone verify portability against. See
Numb Appendix A for object def.
er

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Input Data Elements

Field Name Type Length M/O Additional Information
Check Portability NPA / NXX Telep M TelephoneNumber object to
hone check the portability of (against
Numb above native npa/ nxx).
er

Output Data Elements

Field Name Type Length M/O Additional Information
Native NPA / NXX Telep M
hone
Numb
er
Port Indicator Boole M T/F, It is T if N-PORT-TYPE
an = P and TN-PORT-IND = I
otherwise F is returned.
Port Local Routing Number (LRN) Telep M Local Routing Number
hone
Numb
er

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

5.11 Validate Configuration: Transfer of Call (was Transfer of Call)

Event Name Transfer of Call Validity Check

Applicable Products Single Line Services with Transfer of Call
Trigger End of Negotiate Product Configuration on Move Order.
Pre-Conditions OMS required to validate TN availability check for transfer of call service.
Post-Conditions OMS receives response from ASF.
Source System(s) Amdocs OMS
Target System NetCracker / FMS
Protocol EJB/RMI/IIOP
Interface Type Synchronous
Response Requirements Synchronous
Development Required New interface: Amdocs OMS to Inventory Service to NetCracker
5.11.1 Description
There is a time limit before a client telephone number can be re-used for another client. When a client wishes to
have the Transfer of Call service, a validation that this TN is available for this is needed.

See “Transfer of Calls Validity Check” section of Master SAD

5.11.2 System Modifications & Enhancements

OMS will request the Inventory Service to verify that a TN is still available for transfer of call. The service will
interface with NetCracker and it will call FMS Business Event Get Service Path Details by Components. FMS will
return all service paths for the TN. NetCracker will determine if the TN is still available for Transfer of Call and
respond back to OMS.

5.11.3 Error & Exception Handling

Should an error occur, the method should return a java exception and the calling program can handle it. As well, the
method should use the common framework logging solution to send the error somewhere it can be handled by the
systems operation group.

5.11.4 Interface Data Elements

Input Elements
Field Name Type Length M/O Additional Information
Coid String 10 M
Telephone Number Telephone Number 10 M The telephone number
that will be used to check
Requested Date String 8 M The date when the
number is requested
Csr id String M CSR id recorded for
auditing purposes.

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Output Data Elements

Field Name Type Length M/O Additional Information
Return Code Boolean M True if the transfer of call configuration is valid. False
if it is not.

5.12 Get owner by NPA & NXX

Event Name Get Owner by NPA/NXX

Applicable Products TELUS Digital Phone
Trigger OMS Request for Owner
Pre-Conditions OMS user has manually entered NPA NXX system needs to verify if the
NPA/NXX belongs to TELUS. NetCracker will adjust its workflow based on
who the NPA/NXX owner is.
Post-Conditions Results from Get Owner by NPA/NXX
Source System(s) TN WEB App.
Target System FMS
Protocol Local Java Call from TN WEB App to FMS Adapter
ITOC from FMS Adapter to FMS IMS Transaction
Interface Type Synchronous
Response Requirements Synchronous
Development Required New Interface: FMS API to TN WEB App
5.12.1 Description
This interface will provide the owner name for a given NPA/NXX
5.12.2 System Modifications & Enhancements
It will have to communicate to FMS to retrieve the information.

5.12.3 Error & Exception Handling

See Design Doc.
5.12.4 Interface Data Elements

Input Data Elements

Field Name Type Length M/O Additional Information
Telephone Number Telephone 10 M
Number

Output Data Elements

Field Name Type Length M/O Additional Information
Owner Short Name String 10 M
Owner Full Name String 30 M

5.13 Validate Resources

Event Name Validate Resources

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Applicable Products TTV (for Phase 2a)

Trigger Amdocs OMS request for port reservation & validation (Negotiate Product
Configuration after the product information has been entered)
Pre-Conditions Amdocs requests Port Reservation confirmation
Post-Conditions After confirmation, next BPA (after NPC) is invoked on OMS
Source System(s) Amdocs OMS
Target System Inventory Service  NetCracker
Protocol EJB/RMI/IIOP
Interface Type Synchronous
Response Requirements Synchronous
Development Required New Interface: Amdocs OMS to Service Availability Service to NetCracker
5.13.1 Description
“Validate Resources” will ultimately be invoked by a number of different BPAs that submit Order Actions for a
variety of products. For the purposes of Imagine Phase 2a, this document will address those Order Actions that
contain TTV products only and only those Order Actions will invoke further processing by NetCracker.
If TTV is ordered then a request for reservation of a DSL Port will be made to NetCracker via the Inventory Service.

Ref: ”Validate Resources” section of “ASF MM SAD_AddALL_MASTER” SAD.

5.13.2 System Modifications & Enhancements

A new session bean will be needed to manage all Service Availability requests. A method will be needed to
implement this business event. It will have to communicate to Netcracker for processing.

5.13.3 Error & Exception Handling

See Design Doc.
5.13.4 Interface Data Elements

Input Elements
Field Name Type Length M/O Additional Information
AMDOCS Reserve Port String M The AMDOCS OMS Reserve Port request, and xml
Request XML string which includes:
 The Product Transformational Request (PTR) from
AMDOCS, which includes the product configuration,
with all included features.
 Current Order Action for validation is the one
contained within the Regular Order Action
attribute/section.

Critical information are Service Address and ID, CLLI

Code selected Features, Service Class, and Service
Type, related product information

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Input Elements
Field Name Type Length M/O Additional Information

Other information includes: CSR ID (for auditing)

NOTE: Assert not null

Output Data Elements

Field Name Type Length M/O Additional Information
Generic “VC” status response message containing:

Status String M Success, Failure

Error Severity Indicator String M
Error Code String M 0; if Success
Format TBD
Error Message String M/C (applicable if Error Code is nonzero)
Service Information String O This value could be used for future service
status details (i.e “Service Availability
Date”)
Array of Product specific information
Product Type Indicator String M LOV= Port Reservation Status

NOTE: The particular value indicates the

Product Type (i.e. TTV)
Warning indicator String M LOV = TBD ***

NOTE: This value indicates product

specific constraints that apply (even if query
is “Success”)
Other TTV Specific Data
Other TTV parameters String M LOV = TBD ***

Other Product Specific Data (for possible future use)

Other ToC parameters String M LOV = TBD ***

5.13.5 Sample Events

Output for TTV Product Request

Scenario  No network capacity available for HD service

Status = “Failure”
Error Code = “11233” (i.e. 11 = TTV Product; 233 = particular error)
Error message = “Inadequate network infrastructure for HD TV”

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

5.14 Get Turbo Flag

Event Name Get Turbo Flag For Service Address

Applicable Products Local Line / Internet Services / TTV
NON-Applicable Products Calling Card / IP Applications / VOIP/ Long Distance /CPE / Transfer of Calls
Trigger OMS calls get Turbo Flag to find out if a service address is ETTS/GPON enabled
or not and to find out the technology change flag.
Pre-Conditions Negotiate Service Address has completed successfully and a valid
serviceAddressId and valid Province are available to send to this service.
Post-Conditions Flag to indicate whether path is ETTS/GPON
Source System(s) OMS/DesktopOne
Target System Service Availability Service/NC
Protocol
Interface Type Synchronous
Response Requirements Synchronous
Development Required A new API is to be developed which calls NC and returns a turbo flag and
change of technology flag as a Boolean value

5.14.1 Description

OMS requests the get Turbo Flag API for a Boolean turboFlag flag value and Boolean technology change flag.

The method getAccessNetworkTypeByServiceAddress of NC will be called to determine if the service address

is ETTS/GPON capable. If the service address is ETTS/GPON capable, then Get turbo Flag will return Boolean
variable turboFlag as true otherwise as false. The getPaths method of FMS will be invoked to find out the
technology change flag value.

5.14.2 System Modifications & Enhancements

A method will be needed to implement this business event. It will need to communicate with NC.

5.14.3 Error & Exception Handling

See Design Doc.

5.14.4 Interface Data Elements

Input Data Elements

Field Name Type Length M/O Additional Information
ServiceAddress Object M Province, FMS Address ID should be set in it

Output Data Elements

Field Name Type Length M/O Additional Information
TurboFlagDto Object M

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

TurboFlagDTO Elements
Field Name Type Length M/O Additional Information
turboFlag Boolean M The flag will indicate whether the path returned by
NetCracker is ETTS/GPON enabled or not .
changeOfTechnology Boolean M The flag will indicate whether technology change
Flag has occurred at that address or not.

5.15 GetNetworkTypeBySvcAddress

Event Name Get Network Type By Svc Address

Applicable Products Local Line / Internet Services / TTV
NON-Applicable Products Calling Card / IP Applications / VOIP/ Long Distance /CPE / Transfer of Calls
Trigger OMS/DT1 calls getNetworkTypeBySvcAddress to find out the access path type
(ETTS/GPON/None)at a service address
Pre-Conditions Negotiate Service Address has completed successfully and a valid
serviceAddressId and valid Province are available to send to this service.
Post-Conditions Access path type to show whether path is ETTS/GPON
Source System(s) ASF
Target System Service Availability Service
Protocol
Interface Type Synchronous
Response Requirements Synchronous
Development Required A new API is to be developed which calls NC and returns a string constant
indicating if the access path type of the service address is ETTS/GPON or not.

5.15.1 Description

OMS/DT1 requests the Get Network Type By Svc Address API for access path type value as a string constant.

The method getAccessNetworkTypeByServiceAddress of NC will be called to determine if the service address

is ETTS/GPON capable. If the service address is ETTS/GPON capable, then this API will return “ETTS” or
“GPON” else this API will return “NONE”. This method will return the ETTS and GPON port information also.
5.15.2 System Modifications & Enhancements
A method will be needed to implement this business event. It will need to communicate with NC.

5.15.3 Error & Exception Handling

See Design Doc.

5.15.4 Interface Data Elements

Input Data Elements

Field Name Type Length M/O Additional Information
ServiceAddress Object M Province, FMS Address ID should be set in it

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Output Data Elements. (isETTSPath flag)

Field Name Type Length M/O Additional Information
NetworkAccessPathD Object M 1) Network Access Type – “ETTS”,”GPON” or
etailDTO “NONE”
2) CLLI

5.16 Check Loop Migration Feasibility

Event Name checkLoopMigrationFeasibility

Applicable Products Single Line
NON-Applicable Products Calling Card / IP Applications/ Long Distance /HSIA/TTV
Trigger Request from LSR
Pre-Conditions Valid Service TN
Post-Conditions Indicator of whether the TN is capable of port migration is returned
Source System(s) LSR
Target System ASF
Protocol EJB Remote call from Client to Service availability Service
Interface Type Synchronous
Response Requirements Synchronous
Development Required A new API is to be developed
5.16.1 Description
A request is sent from LSR to check whether Loop Migration should be allowed.

5.16.2 System Modifications & Enhancements

A Session Bean will be needed to manage all Service Address business events. A method will be needed to
implement this business event.
5.16.3 Error & Exception Handling
Refer to Design Doc: AP475 ASF Services Component Design
IllegalTelephoneNumberArgumentException: when the input TN is not valid
TNSearchException: when the TN is not found

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

5.16.4 Interface Data Elements

Input Data Elements

Field Name Type Length M/O Additional Information
TN TelNum M

Output Data Elements (ResponseDTO)

Field Name Type Length M/O Additional Information
Loop Migration String M “Y”, yes, feasible; “N”, no, not feasible; “U”, unable to
Feasibility determine, see error
Error Code String C Populated if the result is “N” or “U”
Error Msg String C Populated if the result is “N” or “U”

5.17 Check PIC-ability By Address

Event Name checkPicabilityByAddress

Applicable Products Single Line
Trigger DT1 requests for PIC-ability when checking for service availability.
Pre-Conditions
Post-Conditions Results from PIC-ability check
Source System(s) DT1
Target System NetCracker
Protocol EJB
Interface Type Synchronous
Response Requirements Synchronous
Development Required new

5.17.1 Description
This interface will check if the address has ETTS/GPON technology and return false if it does, since Derived Voice
is considered non-picable service. A true response only indicates the address has copper service only and actual pic-
ability depends on carrier availability, to be further checked according to M&P

5.17.2 System Modifications & Enhancements

A method will be needed to implement this business event. It will have to communicate to Netcracker to retrieve the
information.

5.17.3 Error & Exception Handling

See Design Doc.
5.17.4 Interface Data Elements
Input Data Elements
Field Name Type Length M/O Additional Information
Service Address Address M Required Fields:

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Input Data Elements

Field Name Type Length M/O Additional Information

CO ID
Province – denotes the province at
which the service is provided – assert
not null.
City – denotes the city at which the
service is provided – assert not null.
ServiceAddressID- FMS address Id
See Appendix A for object def.

Output Data Elements – PicStatus

Field Name Type Length M/O Additional Information
Picable Boolean M True if picable
Error code String M Error code. If success, it will be 0. else
it will be “E####”.
Error text String M Description of the message. If
success, it will be “success” else
actual error message based on error
code.
Pic reason Code String M “97” for non-picable service

6 Inventory Service Business Events

6.1 Get Service ID

Method Name Get Service ID

Applicable Products High Speed Internet & STB Component of TTV
NON-Applicable Call Forward Fixed CO Product Calling Card Product, SL, TTV
Products
Trigger To Reserve a TN, OP sends a request to ASF

Pre-Conditions AMDOCS triggers a request for TN Reservation on the Dark HSIA,

CLEC, STB,

Post-Conditions Returned Service ID will be assigned to component in OMS

Source System(s) OP Connector Interface

Target System(s) NC
Protocol EJB call
Interface Type Synchronous
Response Synchronous
Requirements

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

6.1.1 Description

OMS invokes ASF Service to get an Service (TN) associated to an Product.

6.1.2 System Modifications and Enhancements

A Session Bean will be needed to get Service Id. A method will be needed to implement this business
event. It will need to communicate to NC

6.1.3 Error & Exception Handling

Should an error occur, the method should return a java exception and the calling program can handle it. As well, the
method should use the common framework logging solution to send the error somewhere it can be handled by the
systems operation group.

6.1.4 Interface Data Elements

Input Data Elements

Field Name Type Length M/O Additional Information
OA Reference String 35 M Order Action reference number
Number
CSR ID AN 8 M Current user ID of the CSR
Address Address M Street Name, Province, City, House No, FMS Address
ID, Postal Code, Apartment Number, Street Number
Product Type String M Product Type LOV
“STB Reg#” – Set Top Box(TTV)
“Dark DSL” – dark HSIA (inc. ETTS/GPON HSIA)
“CLEC ADSL”– Non TELUS (CLEC ADSL)

Service Path ID String C The clearance path id that CSR selected; only applicable
for HSIA when not bypassing getClearancePath

Interface Data Elements returned from the Get Service Id Method to ASF

Output Data Elements

Field Name Type Length M/O Additional Information
Service ID String 20 M  A service ID (String type),

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Output Data Elements

Field Name Type Length M/O Additional Information
which will be as follows as depicted in one eg
o Eg 7801234561 OR Eg 4541112222

6.2 Get Native NPA/NXX

Event Name Get native NPA/NXX list for central office

Applicable Products Single Local Line
Trigger
Pre-Conditions Validated installation address
Post-Conditions Return list of native NPA/NNX’s
Source System(s) TN Select Web App
Target System NetCracker / FMS
Protocol EJB/RMI/IIOP
Interface Type Synchronous
Response Requirements Synchronous
Development Required New Interface: Amdocs OMS to Service Availability Service to NetCracker
6.2.1 Description

Once AMDOCS has requested and confirmed FMS has a Service Address available for services, the user must be
assigned a NPA and NXX numbers. This would represent the area code and first 3 digits of the telephone number.
Since AMDOCS will have all Service Address Details, it will be able to use information found in this record to call
existing FMS functionality via the Service Availability Service and Netcracker.

See Boxes 8, 9, and 10 as well as 14 and 15 within “Telephone Number Select” section of Master SAD

6.2.2 System Modifications & Enhancements

A new session bean will be needed to manage all Telephone Service requests. A method will be needed to
implement this business event. It will have to communicate to Netcracker and FMS to retrieve the information.

6.2.3 Error & Exception Handling

Should an error occur, the method should return a java exception and the calling program can handle it. As well, the
method should use the common framework logging solution to send the error somewhere it can be handled by the
systems operation group.

InvalidAddressException
getNativeNpaNxxByCoDataAndLocation in Inventory SVC validates Province and City passed from the calling
application by invoking Region Guiding Component in order to check up front whether or not the call will fail in the
FMS Adapter layer.

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

If the call to Region Guiding component fails due to no match found for the passed Province and City values,
InvalidAdressException is thrown. Refer to CR 9276- Region Guiding Error Handling

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

6.2.4 Interface Data Elements

NOTE: Not final. Need to review the nature of paging and filtering with netcracker and OMS. Paging and
filtering should take place in the TS or Netcracker layers – therefore repositioning info (npa, nxx and swu)
should not be required in TS interface. FRED AND JOHN PLEASE FIGURE OUT REQUIREMENTS
FOR THIS ONE. NOTE FROM FRED – ADAPTER IS ONLY RETURNING 100 PER PAGE.

Input Data Elements

Field Name Type Length M/O Additional Information
Coid String 10 M
Co data BasicCoDa For the getNativeNpaNxxByCoDataAndLocation
ta method only.
Province Province 2 M denotes the Province where the service is
requested/provided
City String 20 M denotes the City where service is requested/provided
Csr id String 1 alpha, For auditing
seven
numeric

BasicCoData Object
Field Name Type Length M/O Additional Information
Coid String 10 M
Switch Number String M
Switch Type String O
Rate center String M

Return from Netcracker:

Output Data Elements
Field Name Type Length M/O Additional Information
NXX remark NFA String 10 Indicates the TN to call for NFA help. Populated from
contact I/MCO.
NXX remark line AN String 79 Indicates NFA help remarks. Populated from I/MCO.
1st
NXX remark line AN String 9 Indicates NFA help remarks. Populated from I/MCO.
2nd
NXX available number String 4 Indicates how many NPANXX rows are in the table.
The following is an OK: Current implementation does not handle return
array that occurs 1200 bigger than 1200 records – either NetCracker or TS
times in the FMS needs to implement a lookup of all records prior to
database. filtering. Frank suggests it should be NetCracker that
does the paging not the service. Also the filter code is
slow – talk to John about fixing (using contains rather
iterating over every record).
NXX available NPA String 3
NXX available NNX String 3
NXX available switch String 3 Same as swu?
number
NXX available billing String 2 Indicates the billing period for the NPANXX as defined

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Output Data Elements

Field Name Type Length M/O Additional Information
period code in the corporate NPANXX table.
TN range stat code String 1 Indicates the status for the NPANXX range as defined in
MRG. This field is currently used to help determine the
default NPXNXX to list spare TNs.
NXX available custom String 1 Indicates the switch the NPANXX is available in, can
call flag support custom calling features.
Values are:
Y, N
NXX available status String 1 Indicates The Embargo Code For The NPANXX Range
code As Defined In MCO. This Field Is Currently Used To
Help Determine If The NPXNXX Is Available For
Display Of Spare Tns.
Values Are:
A = NXX Is Available
E = Embargoed (change orders only)
R = Embargoed
N = Embargoed
L = Embargoed

Output to TN Select Web App:

Output Data Elements
Field Name Type Length M/O Additional Information
NXX remark NFA String 10 Indicates the TN to call for NFA help. Populated from
contact I/MCO.
NXX remark line AN String 79 Indicates NFA help remarks. Populated from I/MCO.
1st
NXX remark line AN String 9 Indicates NFA help remarks. Populated from I/MCO.
2nd
Collection of TelNum
Objects as defined
below.
Available NPA / NXX TelNum M All of the available NPA / NXX for the given CO.

6.3 Request / Release Telephone Numbers

Event Name Request / Release Telephone Numbers

Applicable Products !!br0ken!!Single Line / VoIP
Trigger OMS TN selection web app requests Telephone Numbers
Pre-Conditions Successful retrieval of NPA/NXX, valid service address
Post-Conditions Return spare telephone number list
Source System(s) TN Select Web App
Target System NetCracker / FMS
Protocol EJB
Interface Type Synchronous
Response Requirements Synchronous
Development Required New Interface: Amdocs OMS to Inventory Service to NetCracker

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

6.3.1 Description
After selecting the NPA and NXX, the next step for an OMS user will be to request which Telephone Numbers are
available.

See Boxes 18, 19, and 20 as well as 22, 23 and 24 within “Telephone Number Select” section of Master SAD

6.3.2 System Modifications & Enhancements

A new session bean will be needed to manage all Inventory Service requests. A method will be needed to implement
this business event. It will have to communicate to FMS to retrieve the information.

6.3.3 Error & Exception Handling

IllegalTelephoneNumberArgumentException
requestOrReleaseTelephoneNumbers and requestOrReleaseTelephoneNumbersExactMatch in Inventory SVC
validates NPA and NXX passed from the calling application by invoking Region Guiding Component in order to
check up front whether or not the call will fail in the FMS Adapter layer.
If the call to Region Guiding component fails due to no match found for the passed NPA and NXX values,
IllegalTelephoneNumberArgumentException is thrown. Refer to CR 9276- Region Guiding Error Handling
6.3.4 Interface Data Elements
Input Data Elements
Field Name Type Length M/O Additional Information
Coid String M Central Office Id Number
Switch Number String M
Csr id String M For Auditing
queryNumber Telephone O Contain the requested Number. Can be empty but
Number cannot have both queryNumber and
releaseTelephoneNumber empty.
ReleaseTelephoneNumb Telephone An Array containing the release Numbers. Can be
ers Number[] O empty but cannot have both queryNumber and
releaseTelephoneNumber empty.

Telephone Number Object

Field Name Type Length M/O Additional
Information
Npa String 3 M First 3 digits of the
Telephone Number
Nxx String 3 M The next 3 digits
after Npa
Line String 4 O The last four digits
of the Telephone
Number; not
required when
querying by Npa and
Nxx only; required
otherwise
Release Date String 8 O used when clients
request/release
telephone numbers

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

with the
Provisioning

Output Data Elements

TelephoneNumber[] Telephone An array containing numbers with same Npa Nxx to the
Number[] query number.

6.4 Reserve / Un-reserve Telephone Number

Event Name Reserve / Un-reserve TN

Applicable Products Single Line
Trigger OMS TN selection web app requests reservation of a specific TN(s)
Pre-Conditions Delivery and recent of valid TN’s
Post-Conditions Reserved TN will show an association to the OMS order number as well as date
and time stamp in FMS.
Source System(s) Amdocs OMS
Target System Service Availability Service / NetCracker / FMS
Protocol EJB/RMI/IIOP
Interface Type Synchronous
Response Requirements Synchronous
Development Required New Interface: Amdocs OMS to Inventory Service to NetCracker
6.4.1 Description

After selecting the NPA and NXX, the next step for an OMS user will be to reserve/un-reserve one or more
Telephone Numbers. NetCracker shall invoke ‘Unreserve’ after OMS Request Delivery to release any reserved TN’s
that are not being used by the order prior to completing the order. NetCracker shall compare the inventory items
used against the inventory items reserved to determine the difference. Unused items will be un-reserved.

See Boxes 24, 25, and 26, as well as 28, 29, and 30 within “Telephone Number Select” section of Master SAD

6.4.2 System Modifications & Enhancements

A new session bean will be needed to manage all Inventory Service requests. A method will be needed to implement
this business event. It will have to communicate to FMS to retrieve the information.

6.4.3 Error & Exception Handling

Throw TelephoneNumberSearchException for the following Business Errors from FMS:

E6876 - SPARE TEL IS NOT ON SPARE INDEX - CHECK USE CODE

I4280 - TELEPHONE LINE NUMBER REQUESTED IS NOT SPARE
E6634 - NXX DOES NOT EXIST FOR SPECIFIED COID AND SWITCH #
I4283 - NO SPARES FOR NXX, USE CODE OR SU#, IF IN REMOTE PRESS ENTER
E9255 - TELEPHONE NUMBER IS WORKING IN BILLING
I4285 - SPARE TELEPHONE NUMBER IS "HELD-FOR-DISPLAY"
E6877 - NON-DISPLAYABLE SPARE; AGING AND/OR DIRECTORY RESTRICTION

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

For everything else throw runtime exception (InventorySvcException).

6.4.4 Interface Data Elements

Input Data Elements

Field Name Type Length M/O Additional Information
Coid String M Central Office Id Number
Switch Number String M
Telephone Number Telephone
Number
Order Action Ref# String M
Csr Id AN 8 M Assumptions: use to tids or xids

Telephone Number Object

Field Name Type Length M/O Additional
Information
Npa String 3 M First 3 digits of the
Telephone Number
Nxx String 3 M The next 3 digits
after Npa
Line String 4 M The last four digits
of the Telephone
Number
Release Date String 8 O used when clients
request/release
telephone numbers
with the
Provisioning

Output Data Elements

Field Name Type Length M/O Additional Information
Fms Status FmsStatus See Appendix A

6.5 Request / Release Fictitious Telephone Numbers

Event Name Request / Release Telephone Numbers

Applicable Products !!br0ken!!Calling card /
Trigger OMS TN selection web app requests Telephone Numbers
Pre-Conditions Successful retrieval of NPA/NXX, valid Province and City
Post-Conditions Return spare telephone number list
Source System(s) TN Select Web App
Target System NetCracker / FMS
Protocol EJB
Interface Type Synchronous
Response Requirements Synchronous
Development Required New Interface: Amdocs OMS to Inventory Service to NetCracker

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

6.5.1 Description
After selecting the NPA and NXX, the next step for an OMS user will be to request which Telephone Numbers are
available.

See Boxes 18, 19, and 20 as well as 22, 23 and 24 within “Telephone Number Select” section of Master SAD

6.5.2 System Modifications & Enhancements

A new session bean will be needed to manage all Inventory Service requests. A method will be needed to implement
this business event. It will have to communicate to FMS to retrieve the information.

6.5.3 Error & Exception Handling

See Design Doc
6.5.4 Interface Data Elements
Input Data Elements
Field Name Type Length M/O Additional Information
productType ProductTyp M The ProductType is an enum of
e
Calling card, dry ADSL, CLEC ADSL
componentType Component M ComponentType is an enum of:
Type  Call me card
 Regular card
queryNumber Telephone O Contain the requested Number. Can be empty but
Number cannot have both queryNumber and
releaseTelephoneNumber empty.
ReleaseTelephoneNumb Telephone An Array containing the release Numbers. Can be
ers Number[] O empty but cannot have both queryNumber and
releaseTelephoneNumber empty.
province Province M denotes the Province where the service is
requested/provided
city String M denotes the City where the service is
requested/provided
Csr id String M For Auditing

Telephone Number Object

Field Name Type Length M/O Additional
Information
Npa String 3 M First 3 digits of the
Telephone Number
Nxx String 3 M The next 3 digits
after Npa
Line String 4 M The last four digits
of the Telephone
Number
Release Date String 8 O used when clients
request/release
telephone numbers
with the

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Provisioning

Output Data Elements

TelephoneNumber[] Telephone An array containing numbers with same Npa Nxx to the
Number[] query number.

6.6 Reserve / Un-reserve Fictitious Telephone Numbers

Event Name Request / Release Telephone Numbers

Applicable Products !!br0ken!!Calling card
Trigger OMS TN selection web app requests Telephone Numbers
Pre-Conditions Valid Telephone Number
Post-Conditions Reserve / Un-reserve the Telephone Number
Source System(s) OMS
Target System NetCracker / FMS
Protocol EJB
Interface Type Synchronous
Response Requirements Synchronous
Development Required New Interface: Amdocs OMS to Inventory Service to NetCracker
6.6.1 Description
After selecting the NPA and NXX, the next step for an OMS user will be to request which Telephone Numbers are
available.

See Boxes 18, 19, and 20 as well as 22, 23 and 24 within “Telephone Number Select” section of Master SAD

6.6.2 System Modifications & Enhancements

A new session bean will be needed to manage all Inventory Service requests. A method will be needed to implement
this business event. It will have to communicate to FMS to retrieve the information.

6.6.3 Error & Exception Handling

See Design Doc
6.6.4 Interface Data Elements
Input Data Elements
Field Name Type Length M/O Additional Information
Telephone Number Telephone M Contain the requested Number.
Number
OrderActionReferenceN String M
umber

Telephone Number Object

Field Name Type Length M/O Additional
Information

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Npa String 3 M First 3 digits of the

Telephone Number
Nxx String 3 M The next 3 digits
after Npa
Line String 4 M The last four digits
of the Telephone
Number
Release Date String 8 O used when clients
request/release
telephone numbers
with the
Provisioning

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

6.7 Reserve/Un-reserve Service ID

Event Name Reserve/Un-reserve Service ID

Applicable Products Standalone Calling Card , CLEC ADSL, Dry ADSL, and Set top reg #
Trigger Request for reservation of fictitious TN from Amdocs OMS
Pre-Conditions Successful product negotiation between CSR and Customer; Customer
acceptance of a fictitious TN for Standalone Calling Card or Voice Mail
Post-Conditions Reserve fictitious TN and release any unneeded assets reserved during product
negotiation
Source System(s) Amdocs OMS/Web
Target System Service Availability Service / NetCracker
Protocol EJB/RMI/IIOP
Interface Type Synchronous
Response Requirements Synchronous
Development Required New Interface: Amdocs OMS to Inventory Service to NetCracker
6.7.1 Description
See “Select Service Attributes” section of Master SAD.

6.7.2 System Modifications & Enhancements

A new session bean will be needed to manage all Inventory Service requests. A method will be needed to implement
this business event. NetCracker will need to have the functionality to handle this request. NetCracker shall invoke
‘Unreserve’ after OMS Request Delivery to release any reserved ServiceID’s that are not being used by the order
prior to completing the order. NetCracker shall compare the inventory items used against the inventory items
reserved to determine the difference. Unused items will be un-reserved.

(* Note: the name of business event has been changed from “Reserve/Un-reserve Fictitious TN for Standalone
Calling Card or Voice Mail” due to CR2625)

6.7.3 Error & Exception Handling

Should an error occur, the method should return a java exception and the calling program can handle it. As well, the
method should use the common framework logging solution to send the error somewhere it can be handled by the
systems operation group.

6.7.4 Interface Data Elements

Input Data Elements

Field Name Type Length M/O Additional Information
Product Type ProductTy 1 M Expected value are:
pe - enum CLEC ADSL
Dry ADSL
Calling Card
Voice Mail
STB Reg #
Order Action Reference String 35 M From OMS/AMDOCS.

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Input Data Elements

Field Name Type Length M/O Additional Information
Number
Component type Compone 1 M From OMS/AMDOCS.
ntType – Expected values are:
enum Call Me
Regular Card
Province Province M denotes the Province where the service is
requested/provided
City String M denotes the City where the service is requested/provided

Output Data Elements

Field Name Type Length M/O Additional Information
Service ID String 20 M Reserved or un-reserved Service ID

6.8 Request COID by NPA/NXX

Event Name Request COID by NPA/NXX

Applicable Products Single Line
Trigger OMS request for COID by NPA/NXX
Pre-Conditions None
Post-Conditions Return COID,
Source System(s) OMS (TN Web Application)
Target System Service Availability Service / FMS
Protocol EJB from OMS (TN Web App) to Service Availability Service to FMS Adapter
ITOC from FMS Adapter to MegaTran
IMS from MegaTran to FMS
Interface Type Synchronous
Response Requirements Synchronous
Development Required New Interface for FMS and OMS (TN Web App) via the Inventory Service
6.8.1 Description

This functionality will return a COID for a given NPA/NXX in the case where the service address is
invalid.

See “Get COID” section of Master SAD

6.8.2 System Modifications & Enhancements

A new session bean will be needed to manage all Inventory Service requests. A method will be needed to implement
this business event. The new FMS transaction will return COID, Lowest Switching Unit Number and Default
Rate Centre.

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

6.8.3 Error & Exception Handling

Should an error occur, the method should return a java exception and the calling program can handle it. As well, the
method should use the common framework logging solution to send the error somewhere it can be handled by the
systems operation group.

IllegalTelephoneNumberArgumentException
getCoidByNpanxx in Inventory SVC validates NPA and NXX passed from the calling application by invoking
Region Guiding Component in order to check up front whether or not the call will fail in the FMS Adapter layer.
If the call to Region Guiding component fails due to no match found for the passed NPA and NXX values,
IllegalTelephoneNumberArgumentException is thrown. Refer to CR 9276- Region Guiding Error Handling

6.8.4 Interface Data Elements

Input Data Elements

Field Name Type Length M/O Additional Information
Npa String 3 M
Nxx String 3 M
Csr Id String 8 M CSR ID – x/t-id – CR3696

Output Data Elements

Field Name Type Length M/O Additional Information
Basic Co Data
Object
Serving Coid String 4 M
Switch Number String 3 M lowest serving switch
Switch Type String 2 O
Rate Center String 4 M

6.9 Reserve Port

Event Name Reserve Port

Applicable Products ADSL / TTV
NON-Applicable Products Local Line / Long Distance / Calling Card / IP Applications / VOIP
Trigger Amdocs OMS request for port reservation
Pre-Conditions Successful port reservation in FMS
Post-Conditions OMS has what it needs to request install type
Source System(s) Amdocs OMS
Target System Inventory Service  NetCracker  Port Service
Protocol EJB/RMI/IIOP
Interface Type Synchronous
Response Requirements Synchronous
Development Required New Interface: Amdocs OMS to Inventory Service to NetCracker

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

6.9.1 Description
When OMS receives an order for a DSL internet service (or TTV) it will request reservation of a DSL Port to
Netcracker via the Inventory Service. The “Reserve Network Assets” BPA will invoke this event for all Order
Actions that contain ADSL and/or TTV. If NC receives a TTV Order Action then it will send back a “Success”
response without invoking any Port Reservation workflow.
If NC receives an ADSL Order Action (via the Inventory Service) three separate cases will be considered as follows:

1. If there’s a related TTV OA then return “Success” as noted above.

2. If there’s no related TTV OA then proceed to invoke “Reserve Assets” workflow.
3. If there’s an existing TTV service but an ADSL Service change is requested then proceed to invoke “Reserve
Assets” workflow.

Ref: ”Reserve Network Resources” section of “ASF MM SAD_AddALL_MASTER” SAD.

6.9.2 System Modifications & Enhancements

A new session bean will be needed to manage all Inventory Service requests. A method will be needed to implement
this business event. NetCracker will need to have the functionality to handle this request and communicate to legacy
systems.

CR9842: During the change order or soft/firm reservation in reserve port, if port service returns
InvalidLocationException, NetCracker is to return the error message to OMS. NetCracker is to map the port
reservation status to “01” (“Invalid Location”) to telus service and return “Invalid Location” in the error message.

The port service adapter creates new error code for “Invalid Location” to map the InvalidLocationException from
port service. The exception mapping needs to change to map InvalidLocationException to newly created error code.
The Reserve Port service modifies to add new status type “IL” (Invalid Location) for PortReservationStatusType.
The service needs to map the error code (“01”) from NetCracker to newly created PortReservationStatusType
(“IL”).

6.9.3 Error & Exception Handling

Should an error occur, the method should return a java exception and the calling program can handle it. As well, the
method should use the common framework logging solution to send the error somewhere it can be handled by the
systems operation group.

6.9.4 Interface Data Elements

Input Data Elements

Field Name Type Length M/O Additional Information
AMDOCS Reserve Port String M The AMDOCS OMS Reserve Port request, and xml
Request XML string which includes:
 The Product Transformational Request (PTR) from
AMDOCS, which includes the product configuration,
with all included features.
 Current Order Action for validation is the one
contained within the Regular Order Action
attribute/section.

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Input Data Elements

Field Name Type Length M/O Additional Information
Critical information are Service Address and ID, CLLI
Code selected Features, Service Class, and Service
Type, related product information

NOTE: Assert not null

Output Data Elements

Field Name Type Length M/O/C Additional Information
Port Reservation
Status Object
Status String M enumerated:
- SU ------ Yes, success
- UN ------ Unable to reserve
- PN ------- No available ports
-IL --------- Invalid Location

Error Message String C If Unable to reserve, the reason explaining it.

During reserve port if NetCracker does not get a successful response from a call , NetCracker will have to return an
error message to OMS with “04” for NoPortsAvailable, “01” for InvalidLocation for Reserve port event and “501”
for NoPortsAvailable, “01” for InvalidLocation for Reserve port event and “501” for NoPortsAvailable, “506” for
InvalidLocatoion for Validate configuration event OR create a discrepancy order for anything else.

Reserve Port Validate Configuration

Code Text Code Text

No Ports Available 04 returnNoAvaiablePort 501 No ports available
AAIS_NO_PORTS_AVAILABLE sToOms
Invalid Location 01 returnInvalidLocation 506 Invalid location, CSR may
AAIS_INVALID_LOCATION ToOMS need to check the CLLI

6.10 Get Provisioning Attributes

Event Name Get Provisioning Attributes

Applicable Products Local Line / Long Distance / Internet Services / TTV
NON-Applicable Products Calling Card / IP Applications / VOIP
Trigger Amdocs OMS request for calculated install type
Pre-Conditions Successful port reservation in AAIS BB
Post-Conditions OMS readiness to consult DDS based on calculated install type. Upon customer
acceptance, firm Order from OMS, NetCracker to determine distribution
requirements.
Source System(s) Amdocs OMS

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Target System Inventory Service / NetCracker / FMS

Protocol EJB/RMI/IIOP
Interface Type Synchronous
Response Requirements Synchronous
Development Required New Interface: Amdocs OMS to Inventory Service to NetCracker
6.10.1 Description
Before an order can be scheduled and then accepted by a user, NetCracker must ensure all order action
recommended install types be recalculated and other attributes returned according to the products that have been
ordered. Each order action will individually return the output fields below per order action from OMS.

See Boxes “Get Provisioning Attributes” section of Master SAD.

6.10.2 System Modifications & Enhancements

A new session bean will be needed to manage all Inventory Service requests. A method will be needed to implement
this business event. The method will need to call Netcracker functionality that will use local stored POTS features
and/or call FMS for some information.

6.10.3 Error & Exception Handling

Should an error occur, the method should return a java exception and the calling program can handle it. As well, the
method should use the common framework logging solution to send the error somewhere it can be handled by the
systems operation group.

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

6.10.4 Interface Data Elements

Input Elements
Field Name Type Length M/O Additional Information
AMDOCS OMS Get Provisioning Requirements String M The AMDOCS OMS Get
Request XML String Provisioning Requirements String,
which includes:

The Product Transformational

Request from AMDOCS, which
includes the product configuration,
with all included features, etc.

Current Order Action for validation

is the one contained within the
Regular Order Action
attribute/section.

Critical information are Service

Address and ID, CLLI Code
selected Features, Service Class,
and Service Type and clearance
path information.

Assert not null

Output Data Elements

Field Name Type Length M/O Additional Information
Assignment Type String Manual, Auto, N/A
Activation Type String Manual, Auto, N/A
Install Type String SW=Software, RW=Rack Work
and FW=Field Work
SWT Times Time (Issue: T2076) Requires
more analysis to confirm what
this functionality requires.
Work Time Min String (minimum work time)

Work Time Max String (maximum work time)

Work Time Default String (default work time)

Default Bucket String BWT/SWT (requires final

confirmation from analysis if this
is feasible)
DDS Time Booking Required Boole True – DDS time booking is
an required.
False – DDS time booking is not
required.

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Output Data Elements

Field Name Type Length M/O Additional Information

This field has been added for CR

3400 (Imagine-ASF)

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

7 Service Order Service Business Events

7.1 Request Pre-firm Assignment

Event Name Request Pre-firm Assignment

Applicable Products All Products
Trigger OMS will request NetCracker to create a pre-firm FMS service order
Pre-Conditions Due Date has been negotiated OMS has negotiated a valid Service Address.
Post-Conditions FMS has created and provide feedback to OMS.
Source System(s) Amdocs OMS
Target System Service Order Service / NetCracker / FMS
Protocol EJB/RMI/IIOP
Interface Type Asynchronous
Response Requirements Asynchronous
Development Required New interface: Amdocs OMS to Service Order Service to NetCracker
7.1.1 Description

At the end of Negotiate Due Date, OMS will request NetCracker to create a pre-firm FMS service order.
NetCracker will create the order using the X switch schedule method to prevent switch and rack work triggers. FMS
shall provide back to NetCracker the result of the order creation. NetCracker shall provide back to OMS the result
of the order creation.

See boxes 1 – 10 within “Assignment of Order” section of Master SAD

7.1.2 System Modifications & Enhancements

A new session bean will be needed to manage all Service Order requests. A method will be needed to implement this
business event. The method will need to call Netcracker functionality that will use local stored POTS features and/or
call FMS for some information.

7.1.3 Error & Exception Handling

Should an error occur, the method should return a java exception and the calling program can handle it. As well, the
method should use the common framework logging solution to send the error somewhere it can be handled by the
systems operation group.

7.1.4 Interface Data Elements

Input Elements
Field Name Type Length M/O Additional Information
AMDOCS OMS Attempt Auto Assignment XML String M The AMDOCS OMS Attempt Auto
String Assignment String, which includes:

The Product Transformational

Request from AMDOCS, which

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Input Elements
Field Name Type Length M/O Additional Information
includes the product configuration,
with all included features, etc.

Current Order Action for validation

is the one contained within the
Regular Order Action
attribute/section.

Critical information are Service

Address and ID, CLLI Code
selected Features, Service Class,
and Service Type and clearance
path information.

NOTE: There is no output defined for this method. The OMS connector will return an “AK” status back to
AMDOCS OMS after the method has successfully executed. Verified w/ Jim Daniel + Dani Cohen. Tracked in
Defect #5205 (Imagine/ASF project)

7.2 Pre-firm Cancel/Amend Withdraw

Event Name Pre-firm Cancel

Applicable Products Local Line
Trigger Customer rejects the order or reject the last amend of order
Pre-Conditions Valid service address and address details have been retrieved, clearance path
and service eligibility checks have been completed, TN selection has been made
and or ports have been reserved. In other words, the CSR has executed all the
appropriate steps to outline the complete service offering(s) to the customer for
acceptance. A pre-firm order has been created in FMS.
If amendIndicator is set to true to perform the withdraw amend, the order should
have a previous amend action.
Post-Conditions if AmendIndicator = ‘False’
Perform immediate cancel. NetCracker to release all assets (ports or TN)
that were reserved during the order process. FMS order is cancelled.
if AmendIndicator = ‘True’
Perform amend cancel. NetCracker to cancel the last amend and restore
order to the point before the amend order action.

Source System(s) Amdocs OMS

Target System Service Order Service / NetCracker / FMS
Protocol EJB/RMI/IIOP
Interface Type Asynchronous

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Response Requirements Asynchronous

Development Required New Interface: Amdocs OMS to Service Order Service to NetCracker

7.2.1 Description
When the customer rejects the order, a pre-firm cancel request will be sent to the Service Order Services so
NetCracker can release all assets and cancel the FMS order. Logically this will be sent from OMS prior to Negotiate
Due Date. There will be no response message other than the asynchronous acknowledgment message for the cancel
event.

7.2.2 System Modifications & Enhancements

A new session bean will be needed to manage all Service Order requests. A method will be needed to implement this
business event. Pre-firm cancel will cancel all reserved facilities as well as cancel the FMS service order if it has
already been created. If service order has not been created, need to invoke FMS Pre-firm TN cancel business event,
otherwise invoke FMS Cancel Path business event.

7.2.3 Error & Exception Handling

Should an error occur, the method should return a java exception and the calling program can handle it. As well, the
method should use the common framework logging solution to send the error somewhere it can be handled by the
systems operation group.
7.2.4 Interface Data Elements

Input Elements
Field Name Type Length M/O Additional Information
OM Order Action Reference Number String M Current Order Action for validation
is the one contained within the
Regular Order Action
attribute/section.

amendIndicator Boolean M TRUE: withdrawn amend action

FALSE: prefirm cancel

NOTE: There is no output defined for this method. The OMS connector will return an “AK” status back to
AMDOCS OMS after the method has successfully returned. Note that the successful return of this
method indicate the request is received successfully by the downstream provisioning system. It does not
indicate the cancel or the withdraw action has been successful.

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

7.3 Suspend Service Order

Event Name Suspend Service Order

Applicable Products Single Line / Internet Services / TTV/ VOIP
Trigger Service appointment is unbooked from duedate web app.
Pre-Conditions Order has past Request Delivery stage but not after the In-Flight Due
Date PONR. This request is not applicable to In-Flight Cancel order
actions
Post-Conditions Upon receiving suspend provisioning request, NetCracker will:

 Un-schedule and cancel all future scheduled distributions

created for the order (including scheduled AWAS, ASMS,
ASAP, NSIP, COS, OCA etc. distributions)
 Update all FMS orders created for the suspended service order
in FMS with switch schedule flag = ‘H’, ignoring all non-
connection related errors returned for this requests from FMS.
 If AWAS order has been distributed already but not completed
yet then send cancel order request to AWAS.
 If Change or Remove ADSL order request has been sent to
BB/NetProvisoning then send Change Due Date request with
Due Date = current date + 1 year
 If Update Account has been sent to OCA already then send
compensating Update Account message with information
retrieved from service instance (“old product”).
 Q system Order Notification interface will be extended to nullify
the due date in order to notify Q users that order is suspended.
 Mark service order as “suspended”
Source System(s) Amdocs OMS
Target System Service Order Service / NetCracker
Protocol EJB/RMI/IIOP
Interface Type Synchronous
Response Requirements Synchronous
Development Required New Interface: Amdocs OMS to Service Order Service to NetCracker

7.3.1 Description
If TELUS could not fulfill an appointment with customer for whatever reason, (e.g. technician is unable to
perform the installation due to customer being unavailable), TELUS needs to support the functionality to
“unbook” a previously booked appointment. The time assigned to the appointments could then be
released back to the pool and be made available to other appointments. This service will call NetCracker
to suspend provisioning of service order.

7.3.2 System Modifications & Enhancements

A new method will be added to Service Order interface.

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

7.3.3 Error & Exception Handling

Should an error occur, the method should return a java exception and the calling program can handle it. As well, the
method should use the common framework logging solution to send the error somewhere it can be handled by the
systems operation group.
7.3.4 Interface Data Elements

Input Elements
Field Name Type Length M/O Additional Information
OrderActionReferenceNumber String M Assert not null

Output Elements:

There is no output for this method. The successful return of this method indicate the request is received
successfully by the downstream provisioning system. It does not indicate the successful suspension of
the order.

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

7.4 IsDueDateFeasibile

Event Name IsDueDateFeasibile

Applicable Products Internet Services / TTV (SD & HD)
NON-Applicable Products Satellite TV, Single Line features, VOIP, LD, Calling Card, etc.
Trigger AMDOCS OMS request for Embargo Date Check
Pre-Conditions Order should already Negotiated in OMS
Post-Conditions ServiceAvailibility returned to OMS
Source System(s) OMS
Target System NetCracker
Protocol EJB/RMI/IIOP
Interface Type Synchronous
Development Required New ASF Interface to take Order Number and Due Date as input
parameter

7.4.1 Description

Order Management system (OMS) will send the OrderNumber and Duedate to check the doability based
on the Embargo start and end Date (Migration of Physical Devices in Network Layer) to the ASF services,
ASF will call to the NetCracker and get the respective dates and compare with due date and return the
respective response to OMS on doability.

ASF is to add new API to accept the order number ( OARN) and Order Due date from OP (Order
Processing).

7.4.2 System Modifications & Enhancements

ASF will call NetCracker ServiceQualificationByEmbargodate method and get embargo start and end date
result from NetCracker to be compare with Duedate and return the doability to Ordering.

The new API to be created between OMS to ASF and ASF to NetCracker.
7.4.3 Error & Exception Handling
Please refer the Dtail design document.
7.4.4 Interface Data Elements

Input Data Elements

Field Name Type Length M/O Additional Information
OrderNumber String 10 M This is an OMS OrderNumber
DueDate Date M Customer requested Due Date

(YYYY-MM-DD)

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Output Data Elements

Field Name Type Length M/O Additional Information
FeasibilityStatus Boolean Var M True / False

If NC returns – True

If NC returns an Exception when no Order for

the given OARN is found -- TRUE

If due date is in range of Embargo Start and

End dates – False else True
For Anyother exception -- True

7.4.5 Sample Event

Sample message – standard java format expected.

7.5 Request Delivery

Event Name Request Delivery

Applicable Products All Products
Trigger Customer accepts the order, Order Action past the committed milestone
Pre-Conditions Customer accepts the order
Post-Conditions NetCracker to determine distribution requirements (Box 101)
Source System(s) Amdocs OMS
Target System Service Order Service / NetCracker / Legacy Systems
Protocol EJB/RMI/IIOP
Interface Type Synchronous
Response Requirements Synchronous acknowledgement
Development Required New interface: Amdocs OMS to Service Order Service to NetCracker
7.5.1 Description

When the customer accepts the order, OMS will submit all AMDOCS order information for processing. This will
result in determining distribution requirements, the creation of a new CSS header and distribution of the order
information to the various legacy systems.

See Box 30 in “Request Delivery” and Box 101 in “Determine Distribution” sections of Master SAD

7.5.2 System Modifications & Enhancements

A new session bean will be needed to manage all Service Order requests. A method will be needed to implement this
business event. The method will need to call Netcracker functionality that will process the order as required and
communicate with legacy systems.

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

7.5.3 Error & Exception Handling

Should an error occur, the method should return a java exception and the calling program can handle it. As well, the
method should use the common framework logging solution to send the error somewhere it can be handled by the
systems operation group.

7.5.4 Interface Data Elements

Input Elements
Field Name Type Length M/O Additional Information
AMDOCS OMS Request Service XML String String M AMDOCS OMS Request Service
XML String, which includes:

The Product Transformational

Request from AMDOCS, which
includes the product configuration,
with all included features, etc.

Current Order Action for validation

is the one contained within the
Regular Order Action
attribute/section.

Critical information are Service

Address and ID, CLLI Code
selected Features, Service Class,
and Service Type and clearance
path information.

Assert not null

NOTE: There is no output defined for this method. The OMS connector will return an “AK” status back to
AMDOCS OMS after the method has successfully executed. Verified w/ Jim Daniel + Dani Cohen. Tracked in
Defect #5205 (Imagine/ASF project)

7.6 Get Circuit Paths

Event Name Get Circuit Paths per service address

Applicable Products Internet Services / TTV
NON-Applicable Products Calling Card / IP Applications / VOIP/ Long Distance /CPE / Transfer of
Calls/Local line
Trigger ASF requests NC to get the circuit paths at any given address for new
technologies
Pre-Conditions Valid Address is available to send to this service.
Post-Conditions Circuit Paths are received from NC
Source System(s) ASF
Target System NetCracker
Protocol EJB from Client to Service Address Service
Interface Type Synchronous

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Response Requirements Synchronous

Development Required New Interface: ASF to NetCracker

7.6.1 Description

ASF calls NetCracker to find out circuit paths at any given address for new technologies (ETTS/GPON)

7.6.2 System Modifications & Enhancements

A new Session Bean will be needed to manage all business events. A method will be needed to implement this
business event. It will need to communicate to NetCracker. This is a new functionality which will return the circuit
paths at any given address for new technologies (ETTS/GPON)

7.6.3 Error & Exception Handling

See Design Doc.

7.6.4 Interface Data Elements

Input Data Elements

Field Name Type Length M/O Additional Information
FMS Address Id String M FMS Addressn Id
FMS Region Id String M FMS Region Id

Output Data Elements.

Field Name Type Length M/O Additional Information
CircuitPathsDto Object M Circuit Paths Object Array
Array (Currently this array will have only one element as only
physical path exists)

CircuitPathsDto
Field Name Type Length M/O Additional Information
PathId String C Mandatory for ETTS( Object Id of ETTS floor
Switch port)
Primary TN String M The TN or circuit number at the address (whether
working or not).
Due Date String 8 M Due date

ServicePathStatus String 1 O Possible values –

I – For only first provide of any service at that

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

CircuitPathsDto
Field Name Type Length M/O Additional Information
address

O – When all the services at that address are to

be ceased

N – Non-Working services(Future use)

W- Working services(Future use)

When there is No first service pending In and No

All services pending out exists, this string should
not be filled.

7.7 Notify Tracking

Event Name Notify Tracking

Description For Retroactive orders OMS/OP will send updates to ASF before notify billing
activity and then ASF should propagate this notification to NetCracker
Applicable Products OMS/OP
ASF
NetCracker
Trigger OMS/OP shall notify ASF whenever agents submit Retroactive orders in OMS
Pre-Conditions 1. Retroactive order is created in OMS.
2. The order reaches the Notify Tracking activity before Notify Billing

Post-Conditions 1.Retroactive order is sent to NetCracker

2.NetCracker updates service instance
Source System(s) OMS/OP
Target System NetCracker
Protocol EJB/RMI-IIOP
Interface Type Synchronous
Response Not applicable
Requirements
Development New Interface
Required

7.7.1 Description

For Retroactive orders OMS/OP will send updates to ASF before notify billing activity and then ASF
should propagate this notification to NetCracker.

7.7.2 System Modifications and Enhancements

A method will be needed to implement this business event. The method will need to call Netcracker
functionality that will process the order as required.

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

7.7.3 Error and Exception handling

Should an error occur, the method should return a java exception and the calling program can handle
it. As well, the method should use the common framework logging solution to send the error
somewhere it can be handled by the systems operation group.

7.7.4 Interface Data Elements

Input Elements
Field Name Type Length M/O Additional Information
AMDOCS OMS XML String String AMDOCS OMS Request
Service XML String, which
includes:
The Product Transformational
Request from AMDOCS

8 Delivery Notifications Business Events

8.1 Work Item Status Notification

Event Name Work Item Status Notification

Applicable Products All Orders
Trigger Successful receipt of work-item status to NetCracker
Pre-Conditions Successful receipt of work-item status to NetCracker
Post-Conditions Status Notification from all activation systems
Source System(s) NetCracker
Target System Amdocs OMS
Protocol MQ
Interface Type Asynchronous
Response Requirements No Response Required (NetCracker to push the messages to OMS)
Development Required New Interface between NetCracker and OMS to provide provisioning and
activation status messages
8.1.1 Description

Messages to notify OMS of work order action status when Netcracker is notified by legacy systems.

See flow between Boxes 107 and 108c within “Distribution” section of Master SAD.

8.1.2 System Modifications & Enhancements

Netcracker will need to publish this new message event when it receives status messages from legacy systems.
There should be a message publishing class to abstract the MQ framework code implementation.

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

8.1.3 Error & Exception Handling

Should an error occur, the method should return a java exception and the calling program can handle it. As well, the
method should use the common framework logging solution to send the error somewhere it can be handled by the
systems operation group.

The MQ message hub should be able to handle error situations and ensure message get delivered.

8.1.4 Interface Data Elements

Output Data Elements

Field Name Type Length M/O Additional Information
Order Action ID AN 10 M OMS Identifier
Order Action Ref # AN 35 M OMS Identifier

Status AN M Success, Failure, Other

Status Level AN Final/Intermediate
Amend PoNR BO True  Cannot supplement the OA (default is false,
unless final success status)
Cancel PoNR BO True  Cannot cancel the OA (default is false, unless
final success status)
Reason Code AN C
Remarks AN C
Delivery Completion DTIME O
Date

8.1.5 Sample Event

<Provide a sample event or message. For example, if it is an xml message provide a sample of the xml message.
For example, if it is an xml message provide a sample of the xml message.>

8.2 Due Date Change Notification

Event Name Due Date Change Notification

Applicable Products All Orders
Trigger Notification: failure message from activation system
Pre-Conditions Assignment failed
Post-Conditions CSR must contact customer to renegotiate due date
Source System(s) NetCracker
Target System Amdocs OMS
Protocol MQ
Interface Type Asynchronous
Response Requirements No Response Required (NetCracker to push the messages to OMS)
Development Required New Interface between NetCracker and OMS to replace existing interface
between FMS and CRIS

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

8.2.1 Description
When a failure message from an activation system is received in Netcracker, OMS will be notified so a CSR knows
to renegotiate the due date.

See flow between Boxes 107, 108a and 108b within “Distribution” section of Master SAD.

8.2.2 System Modifications & Enhancements

Netcracker will need to publish this new message event when a due date change is required and OMS needs to be
notified. There should be a message publishing class to abstract the MQ framework code implementation.

8.2.3 Error & Exception Handling

Should an error occur, the method should return a java exception and the calling program can handle it. As well, the
method should use the common framework logging solution to send the error somewhere it can be handled by the
systems operation group.

The MQ message hub should be able to handle error situations and ensure message get delivered.

8.2.4 Interface Data Elements

Output Data Elements

Field Name Type Length M/O Additional Information
Order Action ID AN 10 M OMS Identifier
Order Action Ref # AN 35 M OMS Identifier

Status AN M Failure
Status Level AN M Final
Amend PoNR BO M True
Cancel PoNR BO M True
Reason Code AN M DUEDATECHANGE
Remarks AN M non-success status remarks
Delivery Completion DTIME O NULL
Date

8.2.5 Sample Event

<Provide a sample event or message. For example, if it is an xml message provide a sample of the xml message.
For example, if it is an xml message provide a sample of the xml message.>

8.3 Order Complete Notification

Event Name Order Complete Notification

Applicable Products All Orders
Trigger Notification from activation systems responsible for automatic or manual
completion of the order.

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Pre-Conditions Successful assignment message from all systems responsible for the automatic or
manual completion of the order
Post-Conditions Order moves out of “Pending” status; OMS can notify billing of working service.
Source System(s) NetCracker
Target System Amdocs OMS
Protocol MQ
Interface Type Asynchronous
Response Requirements No Response Required (NetCracker to push the messages to OMS)
Development Required New Interface between NetCracker and OMS to replace existing interface
between FMS and CRIS
8.3.1 Description
When an order has been completed in Netcracker OMS will be notified.

See flow between Boxes 111 and 150 within “Distribution” section of Master SAD.

8.3.2 System Modifications & Enhancements

Netcracker will need to publish this new message event when it receives confirmation that an order has been
complete. There should be a message publishing class to abstract the MQ framework code implementation.

8.3.3 Error & Exception Handling

Should an error occur, the method should return a java exception and the calling program can handle it. As well, the
method should use the common framework logging solution to send the error somewhere it can be handled by the
systems operation group.

The MQ message hub should be able to handle error situations and ensure message get delivered.

8.3.4 Interface Data Elements

Output Data Elements

Field Name Type Length M/O Additional Information
Order Action ID AN 10 M OMS Identifier
Order Action Ref # AN 35 M OMS Identifier

Status AN M Success
Status Level AN M Final
Amend PoNR BO M True  Cannot supplement the OA
Cancel PoNR BO M True  Cannot cancel the OA
Reason Code AN O
Remarks AN O
Delivery Completion DTIME M This is the actual provisioning date, if success - is
Date mandatory

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

8.4 Order Delay Notification

Event Name Order Delay Notification

Applicable Products All Orders
Trigger Notification: Manual intervention (escalation) for missed work item
Pre-Conditions Assignment not completed successfully within the time frame committed to the
customer
Post-Conditions CSR must contact customer to renegotiate due date
Source System(s) NetCracker
Target System Amdocs OMS
Protocol MQ
Interface Type Asynchronous
Response Requirements No Response Required (NetCracker to push the messages to OMS)
Development Required New Interface between NetCracker and OMS to replace existing interface
between FMS and CRIS
8.4.1 Description
When an assignment is not completed successfully within the time frame committed to the customer, an order delay
notification will be sent to OMS.

See flow between Boxes 126 and 151 within “Distribution” section of Master SAD.

8.4.2 System Modifications & Enhancements

Netcracker will need to publish this new message event when an order has to be delayed since some service
activation has not been successful. There should be a message publishing class to abstract the MQ framework code
implementation.

8.4.3 Error & Exception Handling

Should an error occur, the method should return a java exception and the calling program can handle it. As well, the
method should use the common framework logging solution to send the error somewhere it can be handled by the
systems operation group.

The MQ message hub should be able to handle error situations and ensure message get delivered.

8.4.4 Interface Data Elements

Output Data Elements

Field Name Type Length M/O Additional Information
Order Action ID AN 10 M OMS Identifier
Order Action Ref # AN 35 M OMS Identifier

Status AN M Delay
Status Level AN M Intermediate
Amend PoNR BO M False
Cancel PoNR BO M False

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Output Data Elements

Field Name Type Length M/O Additional Information
Reason Code AN O
Remarks AN O
Delivery Completion DTIME O
Date

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

8.5 Non-Doable Work Notification

Event Name Non-Doable Work Notification

Applicable Products All Orders
Trigger Notification: Despite escalation of missed work item, work cannot be manually
completed.
Pre-Conditions Notification: Despite escalation of missed work item, work cannot be manually
completed.
Post-Conditions CSR must contact customer to renegotiate order
Source System(s) NetCracker
Target System Amdocs OMS
Protocol MQ
Interface Type Asynchronous
Response Requirements No Response Required (NetCracker to push the messages to OMS)
Development Required New Interface between NetCracker and OMS to replace existing interface
between FMS and CRIS
8.5.1 Description
When a work order is set to be non-doable, Netcracker will notify OMS that work is non-doable.

See flow between Boxes 111 and 150 within “Distribution” section of Master SAD.

8.5.2 System Modifications & Enhancements

Netcracker will need to publish this new message event when it receives status messages from legacy systems that
indicate the work is Non-Doable. There should be a message publishing class to abstract the MQ framework code
implementation.

8.5.3 Error & Exception Handling

Should an error occur, the method should return a java exception and the calling program can handle it. As well, the
method should use the common framework logging solution to send the error somewhere it can be handled by the
systems operation group.

The MQ message hub should be able to handle error situations and ensure message get delivered.

8.5.4 Interface Data Elements

Output Data Elements

Field Name Type Length M/O Additional Information
Order Action ID AN 10 M OMS Identifier
Order Action Ref # AN 35 M OMS Identifier

Status AN M Failure
Status Level AN M Final
Amend PoNR BO M True  Cannot supplement the OA
Cancel PoNR BO M True  Cannot cancel the OA

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Output Data Elements

Field Name Type Length M/O Additional Information
Reason Code AN M NONDOABLE
Remarks AN M
Delivery Completion DTIME O NULL
Date
8.5.5 Sample Event
<Provide a sample event or message. For example, if it is an xml message provide a sample of the xml message.
For example, if it is an xml message provide a sample of the xml message.>

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Appendix A: Common Objects

OK: I started tabling these, but it’s just a waste of time – need to get the javadoc up so that we can link to
it instead of having to do all this typing.

Address
Property Type Notes
FMS Address ID String FMS System ID – unique id in FMS.

For
SerachServiceAddressforBusinessServices
and GetServiceAddressfor BusinessServices
the Address ID will be Populate as FMS
Instance ID + FMS Address ID.

OMS Address ID String OMS System ID – unique id in OMS.

Apartment String The apartment number – fms maximum is:
<FRED PLEASE FILL THIS IN>
House Number and Suffix String The house number and suffix – fms max:
<FRED>
Street String The street name: fms max: <FRED>
Vector String The street vector: format and max <FRED>
City String The city name: fms max <FRED> - ECCOS
compression rule: <FRED>
Country String The country name: fms max: <FRED> -
ECCOS compression rule: <FRED>
Province String The province name: fms max: <FRED> -
ECCOS compression rule: <FRED>
Postal Code String The postal code: format and max: <FRED>
Address Type String The address type: reserved for later use.
What is this for? Probably Rural and Urban
(re: frank)
CO ID String The ID of the serving CO for this address.
This should be in ServiceAddressDetails, but
has been placed here for convenience as it is
required in every call to FMS.
Rate Center String The Rate Center associated with this address.
This should be in ServiceAddressDetails, but
has been placed here for convenience.
Switch Number String The switch number associated with this
address. This should be in Service Address
Details – it may be moved in a future release.
Switch Type String This switch type of the switch associated with
this address. This should be in Service
Address Details – it may be moved in a future
release.

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

ServiceAddressDetails

Includes all Address fields, plus:

Property Type Notes
CLLI String
Prewire Date String
Enter Phone String
Jurisdiction String
BRA Flag String
BRA Mileage String
TRM Zone String
NNX Code Special String
Comment Line 1 String
Comment Line 2 String
Terminal Code String
Terminal Number String
NPA String 3 digits.
Lowest NXX String 3 digits.
Service Count String
SA ILS Indicator String
Portability Indicator String
SA LRN String
Rating NPA NXX String
Block Address Indicator String
Rate Centre Remarks String
Switch ID String The ID of the serving switch for
this address. Serving Switch
Number and Serving Switch Type
are both in the Address object –
either this should be moved there
as well, or those two should be
moved here.

TelNum

Property Type Notes

Npa String 3 digits
Nxx String 3 digits
Line String 4 digits

SA ODS Status Object

Output Data Elements - SaOdsStatus object.
Field Name Type Length M/O Additional Information
Failure Code String M Code of the failure
Failure Message String M Reason for failure

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

RIT Code Translations

Actual Recommended Install Type Code From

FMS Value Returned by Service
**** FW
*C RW
*D FW
*F FW
*N FW
*R RW
*S SW
*V SW
*W SW
???? FW
IW*C FW
IW*D FW
IW*F FW
IW*N FW
IW*R RW
IW*S SW
IW*V SW
IW*W SW
LC*D FW
LC*F FW
LC*N FW
LC*R RW
LC*S SW
LC*V SW
LC*W SW
LC*C FW
SA*S SW
SA*V SW
SA*W SW
SA*F FW
SA*R RW
TRG* FW

Business Event Call Type Summary

The following table summarizes the business events above with their respective call types:
See individual business events above for specific details.

Last Modified: 2010/06/24 7:11 PM Page of

 AP481 – ASF Mass Market – Telus ASF Services Interface Agreement

Business Event Name Call Type

Complete Partial Address Asynchronous
Get Provisioning Attributes Asynchronous
Request Pre-firm Assignment Asynchronous
Pre-firm Cancel Asynchronous
Request Delivery Asynchronous
Get Calling
Order Features
Action Type LOV Synchronous
Portability / PICAbility Check Synchronous
Portability Check By CO ID and NPA / NXX Synchronous
LOV
Get Nativedescription
NPA NXX Synchronous
Request / Cancel
CA Release TN Synchronous
CC / Cease
Reserve Clearance
Unreserve TN Synchronous
CE
Request / Cease
Release Service ID Synchronous
Reserve
CG / Change
Unreserve Service
Part ID
Of Migrate Synchronous
Reserve
CH Port Change Synchronous
Validate
CI Configuration:
Cease Part OfTransfer
Migrate of Call Synchronous
Validate
CL Configuration: Single
Collection Cease Local Line Synchronous
CM Cease Part Of Move
CO Cease Part Of Overlapping Move
CP Change Pricing and Billing
CU Cease Port Out
CW Change Ownership
CX Change-after-NP-Abort
ES Re-establish
FC Final Cease
MI Migrate
MM Provide Part Of Migrate And Move
MO Migrate And Move
MV Move
OO Overlapping Move
PC Provide Convert
PH Provide Change
PM Provide Part Of Migrate
PO Provide Part Of Overlapping Move
PR Provide
PS Provide Same As
PV Provide Part Of Move
RA Re-establish-After-NP-Abort
RC Cease Part of Replace Offer
RG Change Part of Replace Offer
RO Replace Offer
RS Collection Resume
SU Collection Suspend
UA Update Service Address

Last Modified: 2010/06/24 7:11 PM Page of