Oracle SDP Number Portability

Transcription

1 Oracle SDP Number Portability Implemetatio Guide Release 11i August 2000 Part No. A

2 Oracle SDP Number Portability, Realease11i Part No.A Copyright 2000, Oracle Corporatio. All rights reserved. The Programs (which iclude both the software ad documetatio) cotai proprietary iformatio of Oracle Corporatio; they are provided uder a licese agreemet cotaiig restrictios o use ad disclosure ad are also protected by copyright, patet, ad other itellectual ad idustrial property laws. Reverse egieerig, disassembly, or decompilatio of the Programs is prohibited. The iformatio cotaied i this documet is subject to chage without otice. If you fid ay problems i the documetatio, please report them to us i writig. Oracle Corporatio does ot warrat that this documet is error free. Except as may be expressly permitted i your licese agreemet for these Programs, o part of these Programs may be reproduced or trasmitted i ay form or by ay meas, electroic or mechaical, for ay purpose, without the express writte permissio of Oracle Corporatio. If the Programs are delivered to the U.S. Govermet or ayoe licesig or usig the programs o behalf of the U.S. Govermet, the followig otice is applicable: Restricted Rights Notice Programs delivered subject to the DOD FAR Supplemet are "commercial computer software" ad use, duplicatio, ad disclosure of the Programs, icludig documetatio, shall be subject to the licesig restrictios set forth i the applicable Oracle licese agreemet. Otherwise, Programs delivered subject to the Federal Acquisitio Regulatios are "restricted computer software" ad use, duplicatio, ad disclosure of the Programs shall be subject to the restrictios i FAR , Commercial Computer Software - Restricted Rights (Jue, 1987). Oracle Corporatio, 500 Oracle Parkway, Redwood City, CA The Programs are ot iteded for use i ay uclear, aviatio, mass trasit, medical, or other iheretly dagerous applicatios. It shall be the licesee's resposibility to take all appropriate fail-safe, backup, redudacy, ad other measures to esure the safe use of such applicatios if the Programs are used for such purposes, ad Oracle Corporatio disclaims liability for ay damages caused by such use of the Programs. Oracle is a registered trademark, ad Oracle SDP Number Portability is a trademark or registered trademark of Oracle Corporatio. Other ames may be trademarks of their respective owers.

3 Cotets Sed Us Your Commets... ix Preface... xi Iteded Audiece... Structure... Related Documets... URLs xiii Published Resources xiii Covetios... xi xii xiii xiv Implemetig Oracle Number Portability Cosideratios for Plaig a Implemetatio Project... 2 Number Portability Defied... 2 Applicatio Architecture Modules Features User Roles Other Plaig Cosideratios Typical Release Depedecies Settig Profile Optios 37 Work Items i Oracle Number Portability Purpose of Work Items Predefied Work Items i Oracle Number Portability Stadard Work Item Parameters Madatory Work Item Parameters Default Work Items i Oracle Number Portability Work Item Parameters iii

4 iv Adapters i Oracle Number Portability Fulfillmet Elemet Types i Oracle Number Portability Fulfillmet Elemets i Oracle Number Portability Uderstadig Fulfillmet Actios Uderstadig Fulfillmet Procedures Geographic Areas Defied Service Providers Subscriptio Versios Order Subscriptio Versios Network Subscriptio Versios Defiig a Service Provider Defiig a Portig Status Type Defiig Number Rages ad the Network Map Defiig a Network Map Messagig i Oracle Number Portability How the Evet Maager Hadles Messages Cofigurig imessage Subscriptio The imessage Studio Messages, Evets ad Timers Process Overview Timers ad Jeopardy Maagemet Defiig the Message Data Source Defiig Your Ow Message Processig Logic Compilig imessages Prerequisites Sedig a Test Message Workig with Evet ad Timers Associatig a Respose with a Evet Evet for Timer or Message Ackowledgemet Registerig Default Message Subscribers System Profile Optios The AOL Geeric Loader Loader File Defiitios Trasferrig Lookups to Workflow Dowloadig Portig Lookups to File Dowloadig Commo Lookups to File Creatig a Custom Notificatio Message Message Processig Logic i Oracle Number Portability Icomig Message Process Logic Workflows Cosideratios for Future Upgrade

5 Appedix A: Public APIs PROCEDURE Process_Order... 3 PROCEDURE Cacel_Order... 8 PROCEDURE Process_DRC_Order Pre-Requisites: Appedix B: Sample Workflows Iteral Name:... 3 Descriptio:... 3 Iteral Name:... 4 Descriptio:... 4 Iteral Name:... 5 Descriptio:... 5 Iteral Name:... 6 Descriptio:... 6 Descriptio:... 7 Iteral Name:... 8 Descriptio:... 8 Iteral Name:... 9 Descriptio:... 9 Iteral Name: Descriptio: Iteral Name: Descriptio: Iteral Name: Descriptio: Iteral Name: Descriptio: Iteral Name: Descriptio: Iteral Name: Descriptio: Iteral Name: Descriptio: Iteral Name: Descriptio: Iteral Name: Descriptio: Iteral Name: Descriptio: Iteral Name... : 16 Descriptio: Iteral Name: v

6 Descriptio: Iteral Name: Descriptio: Iteral Name: Descriptio: Iteral Name: Descriptio: Appedix C: SDP Parameters Appedix D: Number Portability Views XNP_GEO_AREAS_VL... 3 XNP_MSG_TYPES_VL... 4 XNP_SV_FE_MAPP_DETAILS_VL... 5 XNP_SV_ORDER_MAPP_DETAILS_VL... 5 XNP_SV_SMS_V... 6 XDP_OE_ORDER_DETAILS_V... 8 XDP_ORDER_DETAILS_V XNP_SV_SOA_VL XNP_SV_STATUS_TYPES_VL Appedix E: Cofigurig Adapters Adapter Architecture... 2 Architecture... 4 Cotrol Message Moitor... 5 Cotrol Messages... 7 State Machie 8 FE Attributes... 9 Coect Procedures... 9 Discoect Procedures... 9 Framework Java Classes Class Hierarchy 11 Java Core Package Adapter Class File Adapter Class FE Attributes for a File Adapter Extedig the File Adapter Extedig Adapters Source for ScriptAdapter.java: FE Attributes for a Script Adapter vi

7 Writig New Adapters Frequetly Asked Questios...27 Appedix F: Implemetig Number Portability Process Sychroizatio Implemetig Number Portability Process Sychroizatio... 3 Defiitios... 4 Major Features... 5 Order Submissio... 5 Sychroizatio at Check Poits... 7 Suy Day Sceario... 8 Error Sceario Time-out Sceario... 0 User Procedures Template ad Algorithms Sychroize Registratio Fuctio Raise Sychroize Error Fuctio Reset Sychroize Register Fuctio Workflow Chages Seed Data Packages Table List SYNC REGISTRATION Busiess Requiremet Stadard Workflow Activities Sychroized Processig Stadard Workflow Activities Example Flow vii

8 viii

9 Sed Us Your Commets Oracle SDP Number Portability, Release 11i Part No. A Oracle Corporatio welcomes your commets ad suggestios o the quality ad usefuless of this documet. Your iput is a importat part of the iformatio used for revisio. Did you fid ay errors? Is the iformatio clearly preseted? Do you eed more iformatio? If so, where? Are the examples correct? Do you eed more examples? What features did you like most? If you fid ay errors or have ay other suggestios for improvemet, please idicate the documet title ad part umber, ad the chapter, sectio, ad page umber (if available). You ca sed commets to us via the postal service. Oracle Corporatio CRM Cotet Developmet Maager 500 Oracle Parkway Redwood Shores, CA U.S.A. If you would like a reply, please give your ame, address, telephoe umber, ad (optioally) electroic mail address If you have problems with the software, please cotact your local Oracle Support Services. ix

10 x

11 Preface Iteded Audiece Welcome to the Oracle SDP Number Portability, Release 11i. This Detailed Implemetatio Guide provides iformatio ad istructios about the implemetatio of the Oracle SDP Number Portability applicatio. This preface explais implemetatio cosideratios ad processes is orgaized ad itroduces other sources of iformatio that ca help you. This guide is aimed at the followig users: Product Implemetatio team (Oracle ad Customer) Oracle ad Customer Project Maagers Techical Support Associates System Admiistrators (SAs), Database Admiistrators (DBAs), ad others with similar resposibility. This guide assumes you have the followig prerequisites: Uderstadig of the product implemetatio processes. Kowledge of Oracle Network Logistics operatio ad services Basic uderstadig of Oracle ad Developer/2000 Uderstadig of the iterface protocol to each of the fulfillmet elemets (telet, script) Backgroud i SQL, PL/SQL, SQL* Plus programmig xi

12 Structure This maual cotais the followig chapters: Cosideratios for plaig Typical Release Depedecies Settig up Profile Optios Settig up System Profiles Cosideratios for Future Upgrades Appedices Public APIs Sample Workflows SDP Parameters Number Portability Views Cofigurig Adapters Implemetig Number Portability Process Sychroizatio xii

13 Related Documets The followig are resources related to Oracle Number Portability: URLs Published Resources Oracle Number Portability User s Guide Oracle Provisioig User s Guide Developig Number Portability Applicatios Referece Guide Oracle Number Portability Techical Referece Maual Developig XML Message Based Applicatio Referece Guide Co figuratio "How To s" User Defied Workflows Workflow Fulfillmet Actios Timers Aim Documetatio CR010: Scope, Objectives, ad Approach BR020: Busiess Requiremets Mappig Form BR110: Applicatio Setup TE070: Uit Test Scripts xiii

14 Covetios The followig covetios are also used i this maual: Covetio... Meaig Vertical ellipsis poits i a example mea that iformatio ot directly related to the example has bee omitted.... Horizotal ellipsis poits i statemets or commads mea that parts of the statemet or commad ot directly related to the example have bee omitted boldface text Boldface type i text idicates a term defied i the text, the glossary, or i both locatios. < > Agle brackets eclose user-supplied ames. [ ] Brackets eclose optioal clauses from which you ca choose oe or oe. xiv

15 Implemetig Oracle Number Portability Implemetig Oracle Number Portability 1

16 Cosideratios for Plaig a Implemetatio Project Cosideratios for Plaig a Implemetatio Project The followig items are part of plaig a Oracle Number Portability Implemetatio: Overview of Oracle Number Portability Applicatio architecture Modules Features ad fuctios User roles Other cosideratios Number Portability Defied Oracle Number Portability eables users of telecommuicatio services o oe switchig system to move or port umbers to a differet switchig system. Oracle Number Portability provides the capability for cosumers to keep their telephoe umbers whe: Switchig betwee telecommuicatio service providers Movig from oe physical locatio to aother Chagig oe telecommuicatio service for aother telecommuicatio service NP is tightly itegrated with Oracle Provisioig. I additio, ONP is capable of iterfacig with a service provider s existig provisioig system or other commercial service provisioig products. ONP is istalled usig Oracle s three tier Iteret Computig architecture ad is fully web-eabled. NP Developmet Number Portability Applicatios ca be defied usig the Oracle Service Delivery Platform ad the predefied NP Work Items, Work Item parameters, Workflows ad Core Fuctios. This guide explais all the predefied Work Items, Workflow activities, NP Core Library Fuctios ad provides a isight ito defiig ew Work Items, Workflow Activities ad other buildig blocks for developig a Number Portability applicatio. Implemetig Oracle Number Portability 2

17 Cosideratios for Plaig a Implemetatio Project Routig Numbers A routig umber makes the portig of umbers betwee switchig systems possible. The routig umber is mapped to the ew telecommuicatio switchig system o the oe ed ad liked to the customer s curret dialig umber o the other ed. Each service provider allocates certai umbers as routig umbers for umber portability. Every service provider usig Oracle Number Portability has a routig umber repository for this purpose. The followig table lists the locatios where routig umbers are recorded ad the purpose of each locatio. Routig Number Repositories Use Executio Cotrol Locatio The service provider s local database Cetral databases maitaied by atioal or regioal umber ceters. These are kow as NRCs i the Uited States. They are also kow as NPAC (Uited States), S-NPAC (Swede), ad CRDC (Belgium). This system is geerically referred to as NRC i Oracle s Number Portability product. This table lists: 1. Where routig umbers are stored 2. Whe umbers are used i the portig process Implemetig Oracle Number Portability 3

18 Cosideratios for Plaig a Implemetatio Project Types of Number Portability The table followig displays the three commoly accepted types of umber portability. The Differet Types of Number Portability Type Service provider portability Locatio portability Service portability Descriptio The ability to retai the same telephoe umbers as the user chages from oe service provider to aother. For example, Dr. Jo Smith moves local telephoe service for his office from Euro Telecom to the ew emergig carrier SuperTel. The physical locatio of Dr. Smith s office has ot chaged. The ability to retai existig telecommuicatio umbers without impairmet of quality, reliability, or coveiece whe movig from oe physical locatio to aother. For example, Dr. Jo Smith moves his office from Brussels to Gothemburg ad retais his existig telecommuicatios umbers with SuperTel. The ability to retai existig telecommuicatio umbers without impairmet of quality, reliability, or coveiece whe switchig from oe telecommuicatios service to aother telecommuicatio service provided by the same service provider. For example, Dr. Jo Smith moves a subset of the telecommuicatios umbers for his office from wirelie service to wireless service with SuperTel. Whe sigig up for wireless service, he retais the existig telecommuicatios umbers with the same set of features that he had with wirelie service. Implemetig Oracle Number Portability 4

19 Cosideratios for Plaig a Implemetatio Project Uderstadig Orders There are a umber of order activities that you carry out i Oracle Number Portability. The followig table lists the types of order activity that you ca perform i the applicatio ad provides a short descriptio of each. Examples of Order Activity i Oracle Number Portability Order Type Port I Port Out Descriptio A port i request is usually iitiated at the recipiet service provider side by a ew customer requestig that you provide a port i capability. A port out request ca occur i oe of two ways: It is triggered iterally at the door service provider side based o the same customer cotact as at the recipiet side. It is possible for a customer to cotact the door service provider directly i order to iitiate a port out request to aother service provider. Note: Stadard activities are provided for the user to build busiess processes for each order type. These order types do ot come seeded with the product. Implemetig Oracle Number Portability 5

20 Cosideratios for Plaig a Implemetatio Project Ways to Submit a Portig Request There are three ways to submit a portig request to Oracle Number Portability. The table followig describes each. Ways to Submit a Portig Request Submissio Type You use the applicatio graphical iterface. You use the APIs provided with the applicatio. (See Appedix A: Public APIs) Descriptio Iformatio is etered through the Port I Request widow, accessed via the Test Ceter. This iclude the followig APIs: Process Order API Submit Order Cacel Order DRC Process Order Implemetig Oracle Number Portability 6

21 Cosideratios for Plaig a Implemetatio Project Portig Phases i Oracle Number Portability There are four portig phases i Oracle Number Portability. The followig table provides a descriptio of each. Portig Phases i Oracle Number Portability Phase Iquiry Orderig Active Old Descriptio A customer calls the ew service provider ad iquires as to the feasibility of portig his/her umber. For example, Dr. Joh Smith may call three ew service providers to ask what the rates would be if he ported his umber. Note that it is possible for multiple portig iquiry requests to be placed for the same telephoe umber at the same time. A customer calls ad requests service from a ew service provider ad asks to keep his/her telephoe umber from the old service provider. Oly a sigle portig order request ca be placed for a telephoe umber at ay give time. For example, Dr. Joh Smith ca oly select oe service provider to port his umber. A customer s telephoe umber is curretly active i the etwork with the ew service provider. Note that the Active phase should ot be cofused with the Active flag. The Active flag is defied for each portig status to idicate whether the portig status is a valid value that ca be used by the applicatio. A portig request that has bee caceled or discoected, etc. It is suggested that, after a specified time period, portig requests with a status i the Old phase should be archived or purged. Typically, the phase of the service order i the umber portig process most ofte determies the tasks that you perform with a service order (but ot always). For example: You perform the tasks associated with eterig orders i the Orderig phase of umber portig. You perform moitorig ad umber rage maiteace ad their compoet tasks i ay phase of a umber portig process. Implemetig Oracle Number Portability 7

22 Cosideratios for Plaig a Implemetatio Project Portig Statuses i Oracle Number Portability Portig statuses are used to track the progress of a portig request. A service order may have more tha oe status throughout its life cycle. You ca defie a ew status through Oracle Number Portability for either of the followig reasos: To better reflect the termiology ad busiess processes of your orgaizatio To uderstad the progressio of a portig request Oce a status is defied it ca be refereced i Workflow ad process logic. These are the places where maipulatio of the statuses occur. Key Compoets of a Portig Status Defiitio I Oracle Number Portability, each portig status is user-defiable. It must also be associated with oe of the pre-defied phases of a portig request. User-defied portig statuses provides flexibility to users (for example, amig covetios are differet for each coutry). Associatig a portig status with a pre-defied portig phase allows applicatios to categorize portig statuses, addig to the maageability of portig requests. The portig phases are: Iquiry Orderig Service Bureau Istallatio Number Portability 11i supports hostig for multiple service providers i a sigle istallatio site because all the umber portability data is idexed usig the service provider ad each user i the site ca oly belog to oe service provider. Also every trasactio i the service bureau mode takes the service provider ito accout. Users ca be assiged to a specific Service Provider from the cofiguratio screes. The value of the SP_NAME profile optio is used as a default for the local service provider. All the umber portability data is idexed usig the service provider ad the site ca offer umber portability services to multiple Service Providers at the same time. Implemetig Oracle Number Portability 8

23 . Cosideratios for Plaig a Implemetatio Project Equal Access Cofiguratio Oracle Number Portability 11i ca also be cofigured to support Equal Access fuctioality through the use of a subscriptio type field i the port-i ad port-out operatios. Subscriptio Type NP EA_LOCAL EA_LD EA_INTL Meaig Implies Local Number Portability Implies portig from oe log distace carrier to aother log distace carrier for iter-lata calls oly. A good example of Iter-LATA call is a call from Sa Fracisco to Sa Jose. Iter-LATA calls ca be viewed as calls withi the same state. Implies portig from oe log distace carrier to aother for iter state calls. A example of a iter-state call is a call from Chicago to New York. Implies portig from oe log distace carrier to aother for iteratioal calls. The sectio below describes how the fields i the subscriptio versio etity will be iterpreted i case of Equal Access. Oly the attributes havig meaig i the Equal Access area is metioed Field Name SV_SOA_ID OBJECT_REFERENCE SUBSCRIPTION_TN SUBSCRIPTION_TYPE DONOR_SP_ID RECIPIENT_SP_ID STATUS_TYPE_CODE CREATED_BY_SP_ID MEDIATOR_SP_ID Descriptio A uique sequetial umber A uique idetifier for this equal access subscriptio. The telephoe umber to be ported from oe log distace carrier to aother. Idicates if the subscriptio is of Equal Access type. The log distace carrier losig the customer. The log distace carrier gaiig the customer. Status of this subscriptio. Refer to cofigurig the status type codes. The service provider who iitiated the portig. Mediatig Service Provider. Implemetig Oracle Number Portability 9

24 Cosideratios for Plaig a Implemetatio Project Field Name CHANGED_BY_SP_ID ROUTING_NUMBER_ID PREV_STATUS_TYPE_ CODE ACTIVATION_DUE_ DATE NEW_SP_DUE_DATE OLD_SP_CUTOFF_DUE_ DATE EFFECTIVE_RELEASE_ DUE_DATE STATUS_CHANGE_ DATE CREATED_DATE MODIFIED_DATE CONCURRENCE_FLAG NEW_SP_ AUTHORIZATION_FLAG OLD_SP_ AUTHORIZATION_FLAG STATUS_CHANGE_ CAUSE_CODE CUSTOMER_ID CUSTOMER_NAME CUSTOMER_TYPE CONTACT_NAME ADDRESS_LINE1 ADDRESS_LINE2 CITY STATE Descriptio N/A N/A Saved status type code. The date o which the subscriptio will be effective. The date the recipiet log distace carrier wats the subscriptio activated. The date the door log distace carrier wats the telephoe umber to be deactivated. The date the log distace service from the door will be discoected. The date the status last chaged. The date the subscriptio was created. The date the subscriptio was modified. Idicates cocurrece from the other carrier. Idicates if recipiet log distace carrier has authorized the portig. Idicates if the door log distace carrier has authorized the portig. The reaso the status was chaged. A uique idetifier for the customer. Name of the customer. N/A N/A Address of the customer. Address of the customer. City State Implemetig Oracle Number Portability 10

25 Cosideratios for Plaig a Implemetatio Project Field Name ZIP_CODE COUNTRY PHONE MOBILE FAX PAGER PAGER_PIN INTERNET_ADDRESS PRICE_CODE PRICE_PER_CALL PRICE_PER_MINUTE Descriptio Zip Code Coutry of the customer Cotact phoe of the customer. Mobile umber of the customer. Tax umber of the customer. Pager Pager pi. N/A N/A N/A N/A Refer to the user guide for cofigurig the service provider, geographic areas ad other umber portability data. Routig Itercoect Areas For Equal Access, you ca also specify the geographic areas valid for each routig umber. This ca allow for queryig up which Routig Number to assig to a customer based o the area i which they live. This has to be doe as part of a FE locator procedure for a FP. SP Gateway You would eed to associate a FE (of type SP Gateway) with every Service Provider defied. This is how the Workflow Sed procedure ca determie which adapter to sed message to. For the NRC, create a SP of type NRC ad associate a FE (of type NRC Gateway). Implemetig Oracle Number Portability 11

26 Cosideratios for Plaig a Implemetatio Project Steps for NP Applicatio Developmet 1. Setup Service Providers ad Fulfillmet Elemets for each of the exteral iterface (Gateways). 2. Setup Services or Work Item parameters. 3. Setup Applicatio Messages, message resposes ad group resposes 4. Defie SDP Fulfillmet Procedures for the pre-cofigured Fulfillmet Actios. 5. Load lookups for messages, FAs, statuses, phases o to workflow lookups 6. Defie Number Portability Busiess Process Workflows. 7. Defie the processig logic, validatio logic ad default processig logic for the messages. 8. Associate workitem parameters based o the workflow activities, icomig ad outgoig messages/evets. 9. Ru Orders Note: See the Provisioig guide for defiig ad associatig Fulfillmet Procedures, Fulfillmet Actios ad Work Items. See Appedix D: Number Portability Views. Implemetig Oracle Number Portability 12

27 Cosideratios for Plaig a Implemetatio Project Implemetig Oracle Number Portability 13

28 Cosideratios for Plaig a Implemetatio Project Exteral Peer Applicatios (NRC, Billig, Other Operator, Workforce Maagemet) Peer Applicatio Iterfaces Order Maagemet System NP Orders File Security Keylists Security Adapters SDP SECURITY MANAGER RSA TCP/IP Commuicatio Protocol Adapters SDP COMMUNICATOR Publish Iteral Evets Object Mappig Message Traslator SDP TRANSLATOR Work Items Order Aalyzer SDP DEPENDENCY MANAGER File Normalized Work Items Workflow Egie SDP WORKFLOW MANAGER TCP/IP Leged Base Module SDP Architecture Module Customizable Compoets SOA=Service Order Admiistratio SMS=Service Maagemet System NRC=Number Registratio Ceter SPM=Service Provider Mediatio SDP Repository Evet Maager SDP EVENT MANAGER Ivoke Callback NP SOA NRC NP SMS NP SPM Itra Applicatio Iterfaces Iter Applicatio Iterfaces Exteral System Number Portability Database (Admiistrative & Referece) Publish Busiess Evet Subscribe Iteral Evets Fulfillmet Actios Fulfillmet Egie SDP FULFILLMENT MANAGER NP Fulfillmet Actio Programs Sed Messages Network Adapters Register Callback Published Busiess Evets Network Activatio Orders Operatioal Support Systems (Billig, Customer Care, Directory) SCP SCP Network STP Switches Implemetig Oracle Number Portability 14

29 Cosideratios for Plaig a Implemetatio Project Applicatio Architecture Oracle Number Portability Scope Service provider portability is the scope of this release of ONP. ONP eables users of telecommuicatio services to keep their telephoe umbers whe they move betwee telecommuicatio service providers. Oracle Number Portability Architecture Oracle Service Delivery Platform (SDP) addresses the challeges of the global umber portability iitiative with the followig fuctios: Service Maagemet System (SMS) Service Order Admiistratio (SOA) Service Bureau (SB) The complete SDP platform is desiged to support umber portability ad will satisfy the door, recipiet ad participat service providers requiremets. The SDP platform ca also be customized to support umber portability requiremets for a cetral system. Implemetig Oracle Number Portability 15

30 Cosideratios for Plaig a Implemetatio Project Modules The followig are modules for Oracle Number Portability: Commuicatio Protocol Adapter A icomig XML message will be take by the appropriate Commuicatio Protocol Adapter. For the iboud XML message, the adapter puts the message i the iboud queue for the Evet Maager. For outboud messages, the applicatio puts the message i the outboud queue. The appropriate commuicatios protocol adapter retrieves the message ad seds it to the associated fulfillmet elemet. Note: If the icomig message is ot i XML, customized adapters are required to covert the message ito XML. If the outgoig eeds to be coverted from XML to aother format, customized adapters are required to covert the message to a differet format. Message Traslator The Traslator module coverts icomig messages from XML to the required ONP format. A XML parser could be used i the icomig processig logic of the message. The Traslator module is ot used for outgoig messages. Order Aalyzer See Oracle Provisioig for iformatio about the order aalyzer ad its ability to maage depedecies withi a order. Implemetig Oracle Number Portability 16

31 Cosideratios for Plaig a Implemetatio Project Workflow Egie This module specifies the actual flow of actios (kow as Fulfillmet Actios) that eed to be executed i order to satisfy a applicatio fuctioality. I essece, this is the module that could re-use the Fulfillmet Actios to customize ay ew fuctioality such as NP Service Provider Mediatio or the NRC itself. The Workflow Egie would determie the Fulfillmet Actios to execute for each Work Item ad determie the Fulfillmet Elemets that it would eed to talk to. It would the place this iformatio o a outboud queue for the Fulfillmet Egie ad otify the Evet Maager of its iterest i the outcome of the executio. Oce it gets a evet otificatio of the outcome of the executio of the Fulfillmet Actio (by the Evet Maager), the egie would proceed to complete the Work Item ad pick the ext Work Item i the queue for the give order. Fulfillmet Egie The Fulfillmet Egie determies the Fulfillmet Elemets o which the Fulfillmet Actios must be applied. There are two key methods by which a Fulfillmet Actio ca be applied o Fulfillmet Elemets. Both methods ca co-exist withi a sigle user-defied Workflow. I oe method, the Fulfillmet Egie determies which Fulfillmet Procedure to execute o the Fulfillmet Elemets. The Fulfillmet Procedure would be a PL/SQL program writte by the ed-user admiistrator durig applicatio setup to provide the fuctioality for the system beig built. This method is typically used by Oracle Number Portability to provisio etwork elemets. I the secod method, the Fulfillmet Egie applies pre-defied fuctios o Fulfillmet Elemets without requirig user-defied PL/SQL programs. The fuctioality to apply these pre-defied fuctios o Fulfillmet Elemets is pre-built i the applicatio. The pre-built fuctios iclude SedMessage, Receive Message ad Publish Evet which are commoly used to support messagig i Number Portability. Oce the executio of the Fulfillmet Actio is completed, it would otify the Evet Maager of its completio. This asychroous architecture allows the Fulfillmet Egie to execute programs which may reside i aother system, be a pre-defied Oracle Workflow or which may ot be PL/SQL based. All outboud messages would be set directly from the Fulfillmet Egie API to the Commuicatio Protocol Adapters for peer commuicatios. Iboud messages from peer systems would use the Evet Maager ad log the icomig messages as Evets. Implemetig Oracle Number Portability 17

32 Cosideratios for Plaig a Implemetatio Project Evet Maager The Evet Maager is a geeric Publish-Subscribe module which registers iterest of various subscribers to differet evet types. The subscribers could be the Traslator (i which case the evet gets propagated as a ew order), Workflow Egie (i which case the evet restarts a Workflow which is waitig o a exteral evet) or the Fulfillmet Egie (i which case a Fulfillmet Procedure ca be ivoked to complete a previous actio). The Evet Maager ca also be used by ay module to publish a busiess evet which could be used to otify exteral systems to iteral ONP evets. A example would be that a M-EVENT-REPORT message from NPAC for a ew customer port-i could publish a busiess evet NEW_ CUSTOMER_ALERT which could be used by exteral Order Maagemet Systems to create a port-i request for the ew customer ad Network Plaig systems to pla for assigig a lie ad telephoe coectio to the ew customer. The Oracle Provisioig repository Cofiguratio module would be used to defie or modify busiess evets ad assig the subscribers to the evet type. This module would also use the publish-subscribe features of Advaced Queues available i Oracle. SDP Repository The core SDP repository allows the user to create orders ad cofigure fulfillmet elemets. The Cofiguratio module withi the core repository allows the user to setup the system after istallatio. A example would be Work Item, Fulfillmet Actio, Fulfillmet Procedure ad Fulfillmet Elemet defiitios. ONP Database The ONP database would cotai etities for storig ONP specific data such as Subscriptio Versio ad Service Provider. The user will also be able to use the SDP Repository Cofiguratio module to customize the ONP specific iformatio. It would take i the appropriate site cofiguratios ad update the repository with customized database objects which are optimized for rutime performace. O completio of the message defiitio, the Cofiguratio would compile defiitio stored i the database ad create a set of stored procedures to implemet the SedMessage ad ReceiveMessage commads. Implemetig Oracle Number Portability 18

33 Cosideratios for Plaig a Implemetatio Project ONP Service Order Admiistratio The mai fuctio of Number Portability Service Order Admiistratio (NP-SOA) is to mediate orders betwee the service provider ad the NRC. Oce the umber portability order has bee mediated by the NP SPM, the NP SOA supplemets the icomig order iformatio with the ecessary ONP data elemets ad coverts it ito a Subscriptio Versio. The iformatio is set for processig by the NRC, which too would cofirm receipt. O the due date, the NP SOA would sed a cofirmatio otificatio for the umber portig which would trigger the NRC to broadcast the portig iformatio. Usage NP-SOA icludes ay commuicatio betwee service providers through the cetral system. This ca iclude: Door Iitiatio Phase Recipiet Iitiatio Phase Cetral System Iitiatio Phase Example: Portig Order request by a customer. Note: The Portig Order request is typically geerated for the followig: Recipiet Service Provider by a order from a upstream system. Cetral System by a message received from the recipiet service provider. Door Service Provider by a message received from the cetral system. ONP Service Maagemet System fuctios Number Portability Maagemet System (NP SMS) coordiates ported umber activatio, chage ad discoect orders from the NRC with the etwork elemets via the SDP Provisioig Compoet (PROV) to provisio ONP services for idividual customers. Upo receipt of a icomig ONP Subscriptio Versio otificatio from the NRC, NP SMS validates the data ad traslates the routig iformatio to provisioig messages that are set to the domai-level NEMS for provisioig the appropriate etwork elemets. NP SMS is also resposible for queryig the local database i respose to audit requests from the NRC or SOA ad seds replies cotaiig ONP data for the records requested. Implemetig Oracle Number Portability 19

34 Cosideratios for Plaig a Implemetatio Project Usage NP-SMS icludes ay commuicatio with service providers which require etwork activatio. This ca iclude: Door Activatio Phase Recipiet Activatio Phase Cetral System Activatio Phase Participat Activatio Phase Example: Portig Activatio request by the recipiet operator o or after the due date. Note: A Portig Activatio Request is typically geerated for oe of the followig: Recipiet Service Provider by a busiess evet from a exteral system. Cetral System by a message received from the recipiet service provider o or after the due date. Door Service Provider by a message received from the cetral system. Participat Service Provider by a broadcast received from the cetral system. Features The mai features of ONP are as follows: Stadard ope APIs for itegratio with upstream orderig systems Tight itegratio with Oracle Provisioig to support provisioig eeds Flexible GUI-based Workflow accommodatig customizatios of service providers customized busiess rules usig a library of ONP fuctios Automatic code geeratio for sedig ad receivig predefied messages to ad from exteral systems i the idustry-stadard XML format Web-eabled iterface usig Oracle s stadard look-ad-feel Local database that maitais a copy of umber portability data ad portig requests Flexible Java-based adapter architecture to support iterfaces to exteral systems Moitorig tools available to track portig order requests ad messagig. Implemetig Oracle Number Portability 20

35 Cosideratios for Plaig a Implemetatio Project User Roles Fidig Iformatio i the NP Ceter You use the NP Ceter to view various kids of iformatio about orders withi the Oracle Number Portability system. This iclude the followig: Iformatio about a existig order Iformatio about etwork elemets associated with a order The iformatio displayed i the NP Ceter is read-oly, ad ca ot be modified i ay way. Viewig Order Iformatio i the NP Ceter To view iformatio about a order, perform the followig steps. Note: The iformatio displayed i the NP Ceter is read-oly. Prerequisites The order must exist i the system before you ca view iformatio about it. Steps 1. I the Navigator, choose Operatios > NP Ceter. 1. Select the Orders tab. 2. Select a order from the Subscriptios list at the left. The Summary scree for that order displays. See Guidelies followig for a descriptio of the form fields ad their meaig. 3. Click Details to display iformatio about a service provider associated with this order. 4. Select the other tabs at the bottom of the scree to display additioal iformatio, if desired. 5. Click Notificatios to ope the Notificatios Ibox, if desired. See Maagig Notificatios for details of the Notificatios Ibox, if ecessary. 6. Click the X i the upper right-had corer of the scree to close it, or select Close Form from the File meu. Implemetig Oracle Number Portability 21

36 Cosideratios for Plaig a Implemetatio Project Guidelies The table followig lists the kids of iformatio that is available from the Orders tab of the NP Ceter. Iformatio Available from the Orders Tab Tab Descriptio Summary Subscriptio Summary Customer ame ad telephoe umber, order status, routig umber, etc. Recipiet Name ad access code of the ew service provider. This is Recipiet i case of Number Portig, or the ew log distace provider i case of Equal Access. Door Name ad access code of the old service provider. This is Door i case of Number Portability or the old log distace provider i case of Equal Access. Mediator Name ad access code of mediatig service provider. This is Number Registratio Ceter i case of Number Portability, or Local Service Provider i case of equal Access. Features The Features tab is ot available uless special features have bee defied for this order. To eable features, set profile optio ENABLE_FEATURES to Y (Yes). Trasactio Log Evet Type Type of evet that affected the portig record. For example, this could be Status Chage or Modificatio. Evet Actual evet, for example, the status of PENDING. Time Stamp Time whe the evet took place. Implemetig Oracle Number Portability 22

37 Cosideratios for Plaig a Implemetatio Project Iformatio Available from the Orders Tab Tab Descriptio Work Items Order ID Service Delivery Platform iteral order idetificatio umber. Order Number Exteral order umber as etered i the Order Etry System. Work Item Work item umber assiged by the system for this order. Status State of this work item. It ca be received, ruig, ready, pedig, or complete. Failed Dowloads Service Provider Code Code for the Service provider who failed to dowload the broadcast iformatio Service Provider Name Service provider ame Failure Date Date whe the failure took place Fial Failure Date Date whe total failure was declared, meaig that there were o more retries Attempted Retries Number of retries attempted to dowload the iformatio successfully Implemetig Oracle Number Portability 23

38 Cosideratios for Plaig a Implemetatio Project Iformatio Available from the Orders Tab Tab Descriptio Others Subscriptio Ower Service provider code for the ower of the subscriptio record (i case of Service Bureau) Pre-Order Authorizatio Number which gives the authorizatio to the service provider to switch the subscriber to aother carrier. Activatio Due Date Date whe activatio must take place Status Chage Date Date whe the status was last updated Ivoice Due Date Date whe the SP must be billed Discoect Due Date Date whe subscriber wishes to discoect service Number Retured Due Date Date whe the ew Service Provider returs the umber to the old Service Provider after discoectig service Effective Release Due Date Date whe the subscriber is completely removed from the old SP system Door Cutoff Due Date Date whe the door wats to remove the subscriber from the system Network Iformatio To view iformatio about the etwork elemets associated with a order, perform the followig steps. Note: The iformatio displayed i the NP Ceter is read-oly, ad ca ot be modified i ay way. Prerequisites The order must exist i the system before you ca view iformatio about it. Implemetig Oracle Number Portability 24

39 Cosideratios for Plaig a Implemetatio Project Steps 1. I the Navigator, choose Operatios > NP Ceter. 1. Select the Network tab. 2. Select a order from the Subscriptios list at the left. The Summary scree for that order displays. See Guidelies followig for a descriptio of the form fields ad their meaig. 3. Click Details to display iformatio about a service provider associated with this order. 4. Select the other tabs at the bottom of the scree to display additioal iformatio, if desired. 5. Click Notificatios to ope the Notificatios Ibox, if desired. See Maagig Notificatios for details of the Notificatios Ibox, if ecessary. 6. Click the X i the upper right-had corer of the scree to close it, or select Close Form from the File meu. Guidelies The table followig lists the kids of iformatio that is available from the Networks tab of the NP Ceter. Implemetig Oracle Number Portability 25

40 Cosideratios for Plaig a Implemetatio Project Iformatio Available from the Network Tab Tab Descriptio Summary Subscriptio summary This icludes the customer telephoe umber, routig Id, etc. Routig service provider ame Service provider ame of the recipiet provider (owig the routig umber) Routig service provider code Service provider code Mediatig Number Registratio Ceter ame Name of the mediatig service provider Mediatig Number Registratio Ceter code Service provider code Implemetig Oracle Number Portability 26

41 Cosideratios for Plaig a Implemetatio Project Iformatio Available from the Network Tab Tab Descriptio Features The Features tab will ot be available uless special features have bee defied for this order. To eable features, set profile optio ENABLE_FEATURES to Y (Yes). Work Items Order Id Order idetificatio umber Order Number Exteral order umber as etered i the Order Etry System Work Item Work item umber assiged by the system for this order. Status State of this work item. (This could be received, ruig, ready, pedig, or complete.) Provisioig Map Features Type Idicates the feature type that has bee provisioed o the etwork elemet.for example, this could be: Routig Number, LIDB, or CNAM. (If the Features fuctioality is ot eabled, the oly the Routig umber for Number Portability is provisioed. This is also called the Primary Routig Number.) Network Elemet Network elemet ame o which the provisioig for this portig record has take place. Network Elemet Type Network elemet type o which the provisioig for this portig record has take place. Provisio Status Status of the provisioig of the etwork elemet. Evets Diagostics You use the Callback Evet Diagostics page to moitor the rutime activities of the callback registratios used by the Evet Maager to route messages to the correct recipiets. Prerequisites Noe Implemetig Oracle Number Portability 27

42 Cosideratios for Plaig a Implemetatio Project Steps 1. I the Navigator, choose Diagostics > Evet. The Callback Evet Diagostics page opes. 2. Eter a value for ay of the displayed fields, the click Fid. For example: To search o the order ID, eter a rage of values i the Order ID fields ad click Fid. To search o order status, select oe from the drop-dow list, the click Fid. To search o a message type, set to a give Service Provider, eter the Service Provider Code i the Receiver field ad click Fid. Ay diagostic messages that meet the search criteria display uder Evet Details. 3. Close the browser widow to exit Diagostics. Timer Diagostics You use the Timer Diagostics page to search for timer messages based o kow details. Timers are used by the system for eforcig time-based rules. This could be, for example, jeopardy or service level agreemet restrictios. Prerequisites Noe Implemetig Oracle Number Portability 28

43 Cosideratios for Plaig a Implemetatio Project Steps 1. I the Navigator, choose Diagostics > Timer. The Timer Diagostics page opes. 2. Eter a value for ay of the displayed fields, the click Fid. For example: To search o the order Id, eter a rage of values i the Order Id fields, ad click Fid. To search o a specific Timer type, click List to ope a list of the valid types, select oe, the click Fid. To search o active timers, eter ACTIVE i the status field ad click Fid. Ay diagostic messages that meet the search criteria display uder Message Details. 3. Close the browser widow to exit this diagostics page. Usig the Cofiguratio Diagostics Tools You use the Cofiguratio Diagostics tool to validate the existig system cofiguratio. The validatio process cosists of two levels: Error: This type idicates the items that must be corrected for the system to work as expected. Warigs: This type idicates potetial problems, but which i some case, are acceptable. Note: It is recommeded that you ru this utility after ay major chage i the system cofiguratio. Prerequisites Noe Implemetig Oracle Number Portability 29

44 Cosideratios for Plaig a Implemetatio Project Steps 1. I the Navigator, choose Diagostics > Cofiguratio. The Cofiguratio Diagostics page opes. This actio dyamically executes a validatio tool that returs iformatio o the validity of the system cofiguratio. 2. Close the browser widow to exit this diagostics page. Maagig Geographic Areas You perform a umber of tasks with geographic areas. These iclude: Defiig a ew geographic area type Defiig a ew geographic area Usig the imessage Studio You use the imessage Studio to maage the task of creatig ew messages. I creatig a message, you must perform the followig tasks i the order listed. Step Task See 1. Defie the details of the message. Creatig a New Message 2. Add elemets to the message. This icludes text, umber ad date/time fields. 3. Set the structure of the relatioships betwee the elemets of the message. 4. Defie the source of the iformatio cotaied i the message. 5. Create ay special logic for processig this message. Addig Message Elemets Settig the Message Structure Defiig the Message Data Source Defiig Your Ow Message Processig Logic 6. Compile the message. Compilig a Message 7. Test the message. Sedig a Test Message If desired, ad it meets your busiess eeds, you ca also create a custom otificatio message. Implemetig Oracle Number Portability 30

45 Cosideratios for Plaig a Implemetatio Project Creatig a New Message To create a ew message, perform the followig steps. Warig: legth. Do ot create message bodies greater tha 32 Kb i Prerequisites Noe Steps 1. I the Navigator, choose Setup > Message Defiitio > imessage Studio. 2. Click the New ico o the toolbar to create a ew message. 3. Eter a ame for the message. 4. Select the Details tab. 5. Select Message from the drop-dow list of available types. 6. Eter a short ame for the message i the Display Name field. This ame is refereced by the message studio whe geeratig procedures. 7. Eter a brief descriptio of the message. 8. Select a priority for the message. This value sets the priority for the message i the outboud or iboud message queue. 9. Select a queue ame from the drop-dow list. If you are ucertai of which to chose, the keep the default value uchaged. 10. Chose a user Resposibility for this message from the drop-dow list. 11. Eter the DTD Locatio path. This value sets the path structure to the file that holds all the schema (Documet Type Defiitios) for this message. The file is amed <message>.dtd, where <message> correspods to the ame of the message you are curretly defiig. 12. Close the widow. You are prompted to save your chages. Implemetig Oracle Number Portability 31

46 Cosideratios for Plaig a Implemetatio Project Refer to Addig Message Elemets for details of how to eter the iformatio for each message elemet that makes up this message. Addig Message Elemets Whe creatig a message defiitio, the Message Code ad MESSAGE are automatically show as madatory messages elemets. The message code is defied as the root elemet. Warig: You must ever delete the root elemet, the message code for this message. To add a message elemet to a message, perform the followig steps. Prerequisites You must create the message details first, before you ca add message elemets to it. See Creatig a New Message for details. Steps 1. I the Navigator, choose Setup > Message Defiitio > imessage Studio. 2. Select the message to which you wish to add elemets from the Message Codes list o the left. 3. Select the Elemets tab. 4. Eter a ame for the elemet that you are addig. 5. Eter the datatype for your message elemet. The message elemet datatype is the XML tag that appears i the message for this elemet. Supported datatypes are: Text Number Date ad time 6. Eter the maximum allowed legth of the data. Implemetig Oracle Number Portability 32

47 Cosideratios for Plaig a Implemetatio Project 7. Eter a default value for this message elemet. You oly specify default values for message elemets that are parameters. The Sed ad Publish geerated procedures raise a error at ru-time if a elemet does ot have a value. 8. Check Madatory if the message elemet must be icluded with the message. 9. Check Parameter if this elemet is to be used as a argumet i geerated procedures. If a message elemet is marked as a parameter, the the default value is used. The imessage Studio geerates a CREATE_MSG(), SEND_MSG(), ad a PUBLISH_MSG() procedures with the elemet as a parameter defaulted to the value specified. 10. Eter a value for the sequece order that you wish the parameter to appear i all the geerated procedures. 11. Close the widow. You are prompted to save your chages. Settig the Message Structure The imessage Studio provides a hierarchical diagrammig that you use to defie the message structure ad to set relatioships betwee message elemets. Oly predefied elemets ca be part of this hierarchy. You ca format a XML message by defiig its structure here. This allows for complex messages, with master detail relatioships. Note: Elemets ca be defied more tha oce withi the structure. Also, message elemets ca be used multiple times throughout the message. To defie the message structure, perform the followig steps. Prerequisites You must create the message details first, before you ca set the message structure. See Creatig a New Message for details. Implemetig Oracle Number Portability 33

48 Cosideratios for Plaig a Implemetatio Project Steps 1. I the Navigator, choose Setup > Message Defiitio > imessage Studio. 2. Select the Structure tab. Use the Structure tab to set up the message elemet hierarchy you require for this message. The oscree Usage Notes describe how to modify the hierarchy. 3. Close the widow. You are prompted to save your chages. Usig the imessage Diagostics Tool You use the imessage Diagostics page to search for rutime messages ad evets based o kow details. Prerequisites Noe Steps 1. I the Navigator, choose Diagostics > Message. The imessage Diagostics page opes. 2. Eter a value for ay of the displayed fields, the click Fid. For example: To search for failed messages, eter FAILED i the status field ad click Fid. To search for messages set to a give Service Provider, eter the Service Provider Code i the Receiver field ad click Fid. To search o Code ad Evet Idicators, click List to ope a list of the valid idicators, select oe, the click Fid. Ay diagostic messages that meet the search criteria display uder Message Details. Implemetig Oracle Number Portability 34

49 Cosideratios for Plaig a Implemetatio Project 3. Click the Message Id to view the details for a message retured by the search. 4. Click the XML lik to view the actual XML versio of the message (if your browser supports this optio). 5. Close the browser widow to exit this diagostics page. Note: If the curret message has a status of FAILED, the Message Details page displays a descriptio of the error. A Fix Message! lik also appears. Clickig this lik re-equeues a message o the iteral evets queue for processig. Although it is possible to correct the error through this lik, it is recommed that correct the error through the Notificatios Ibox. Other Plaig Cosideratios Durig ONP istallatio, profile optios ad the oracle stack must be cosidered. ONP supports may profile optios. The SP_NAME is discussed below. Profile Optios The mode of operatio as Service Bureau or sigle Service Provider is eabled upo istallatio of ONP 3i. The value of the SP_NAME profile optio is used as a default for decidig the local default Service Provider. If this profile optio is ot set, the every user of the system eeds to be associated explicitly with a service provider. The user o logi, will the be associated with the service provider ad ay trasactios performed by the user will the be attributed to that service provider. If the profile optio SP_NAME is set with the code of a service provider, the it is optioal to associate a user with a service provider as the profile optio value is take as the default. This optio may be utilized maily whe the istallatio for a sigle service provider where specifyig the SP for each user is ot ecessary. This optio is importat to cosider sice portig data is secured usig the service provider iformatio ad the site ca offer umber portability services to multiple Service Providers at the same time (the Service Bureau mode). Implemetig Oracle Number Portability 35

50 Cosideratios for Plaig a Implemetatio Project Ask the regulatory body i your coutry What are the atioal ad regioal regulatios regardig ONP? What is the madate for delivery of umber portability i your coutry? Which types of Number Portability is the regulatory body madatig (e.g., Service Provider Portability oly or other types as well)? Is the madate differet for each type of Number Portability? Are there oe or more cetral systems for ONP i your coutry or locatio? If there are multiple cetral systems, what is the coverage area for each? Ask your compay What is your busiess process flow as a (Service Provider):? Door, Recipiet Participat What is the iput data required for each busiess process flow? What are the valid actios that ca be performed o the ONP service? What is the state diagram for a portig request? What types of users will receive otificatios from the applicatio? Are there predefied values such as timer duratio, reject reaso codes, etc.? Are there etwork elemets that require provisioig? What are the umber rages your Service Provider serves? Who are the other service providers i your area? What are the umber rages served by each service provider i your area? What are the exteral iterfaces to the applicatio? What is the commuicatios mechaism for each iterface? What messages are passed o each iterface? What is the message format? Are there ay usolicited messages? What evets must be published by the applicatio? Who are the subscribers Implemetig Oracle Number Portability 36

51 Settig Profile Optios Typical Release Depedecies Oracle Number Portability 11i is based o the foudatio of the Oracle istalled base that icludes: Commo Data Model Commo Schema Techical Stack Oracle Provisioig must be implemeted ad istalled for Oracle umber Portability to work. Settig Profile Optios The followig items must be defied: Work Items i Oracle Number Portability Oracle Number Portability makes use of workflows to automate busiess processes i the same maer as does Oracle Provisioig. Work items perform the busiess ad etwork fuctios ecessary to fulfill a service order request. However, i the applicatio each work item typically maps to a sigle workflow, due to the complexity of the busiess process. That is why workflows are referred to as work items i Oracle Number Portability. The workflows delivered with the applicatio were created usig the Oracle Workflow Builder. You eed to use this applicatio to customize the workflow to meet your busiess eeds. Work items comprise fuctio activities. You may eed to modify some or all of these while customizig the work items for your busiess. The Oracle Workflow istallatio comes with a stadard set of pre-defied otificatios ad fuctio activities to use i buildig busiess processes. The applicatio provides a additioal set of pre-defied stub processes, otificatios ad fuctio activities to support messagig ad the portig process. The stub processes must be customized usig Oracle Workflow Builder. Implemetig Oracle Number Portability 37

52 Settig Profile Optios Purpose of Work Items Number Portability 11i provides a predefied set of SDP Work Items which ca be used to build a umber portability applicatio. Please refer to the Number Portability user guide ad SDP user guide for more iformatio o Work Items, Fulfillmet Actios ad Fulfillmet Procedures. The followig sectio describes each of these Work Items ad the cotext i which they ca be used for buildig a Number Portability applicatio. It also provides the mappig of the Work Item to a Workflow. Every NP Work Item ivokes a Workflow to execute the fuctioality specific to it. To do this, it requires a set of parameters called the Work Item parameters. The Number Portability busiess process is message or evet drive ad is betwee two differet service providers or differet compoets of the same service provider. I order to maitai state or cotext of the busiess process, each Work Item or Workflow should have a set of stadard Work Item parameters i additio to the busiess specific parameters. The developer has to explicitly assig them to the Work Item. The ext sectio describes all the predefied Work Items i the Number Portability product. All the Workflows associated with Work Items are part of the NP Processes item type. Example Workflows implemet the Swedish requiremets. The Workflow display ad iteral ames should match that of the Work Item display ad iteral ames. Implemetig Oracle Number Portability 38

53 Settig Profile Optios Predefied Work Items i Oracle Number Portability Work items are orgaized ito groups kow as item types. The table followig lists the stadard item types delivered with Oracle Number Portability. Do ot modify ay of the stadard Oracle Number Portability item types, except NP Processes. Stadard Work Item Types i Oracle Number Portability Item Type Iteral Name Descriptio Customizable Stadard WFSTD Cotais stadard fuctio activities that are commoly used to create busiess processes. SDP Stadard SDP Lookup Code XDPWFSTD XDPCODES Cotais fuctio activities that are commoly used across both the Oracle Provisioig ad Oracle Number Portability applicatios. It icludes, for example, the followig fuctios: Sed Message Subscribe to Ackowledgmets Cotais lookup types used for easy selectio i workflow activities. This could be, for example, a list of fulfillmet actios, or a list of messages. NP Stadard XNPWFSTD Cotais fuctio activities that are specific to Oracle Number Portability. Use these activities i the implemetatio of your busiess processes. Examples of stadard fuctios are the followig: Creatig a portig order Determiig if portig is possible NP Lookup Code XNPTYPES Cotais lookup types used for easy selectio i workflow activities. This could be, for example, a list of fulfillmet actios, or a list of messages. No No No No No Implemetig Oracle Number Portability 39

54 Settig Profile Optios Stadard Work Item Types i Oracle Number Portability Item Type Iteral Name Descriptio Customizable NP Processes XNPWFACT Cotais coutry-specific umber portability fuctio activities that you customize for differet implemetatios of the applicatio withi the same coutry. Yes It icludes, for example, the followig processes: Process portig iquiry Process portig order Provisio etwork elemet Guidelies 1. I geeral, you should use the SDP Stadard ad NP Stadard fuctio activities wheever possible, ad oly customize the Number Portability activities whe absolutely ecessary. 2. SDP Lookups ad NP Lookups must be updated as you start to cofigure Service Delivery Platform. Ru the Lookups Loader API to update these item types. Referece Cosult the Developig Oracle Number Portability Applicatios Referece Guide, for details o these item types. Stadard Work Item Parameters Busiess processes i Oracle Number Portability are drive by messages or evets. Messages ca be exchaged betwee two differet service providers or betwee differet compoets of the same service provider. To maitai the state or cotext of the busiess process, each work item or workflow must iclude the set of stadard work item parameters i additio to ay busiess specific parameters. The developer must explicitly assig stadard work item parameters to the work item. Work item parameters act as a parameter pool for all the defied work items i Oracle Number Portability. You defie ew work item parameters usig the existig parameters i the pool. I additio, you ca add parameters to the pool to defie ew work item parameters, or to exted existig work item parameters assiged to a work item. Implemetig Oracle Number Portability 40

55 Settig Profile Optios Madatory Work Item Parameters The stadard work item parameters listed i the table followig are madatory for ay Oracle Number Portability work item. All stadard parameters are required for ay message header that is geerated, except the Messaged parameter. The Message_ID is used to idetify the most recet icomig or outgoig message for a work item istace. This is essetial whe maagig messages (for example, as i re-sedig a message). Note: Oracle Number Portability Work Item Parameters are show i the applicatio as the Display Name. Sometimes the display ame differs from the parameter ame. For example, SP_ Name displays i the applicatio as Owig Service Provider. Madatory Work Item Parameters Parameter Name SP_NAME OPP_REFERENCE_ID SENDER_NAME RECIPIENT_NAME MESSSAGE_ID STARTING_NUMBER ENDING_NUMBER Descriptio Code of the service provider for which the work item is executig. Display Name: Owig Service Provider The referece idetifier used o the peer system. All resposes to peer requests should populate this field from the REFERENCE_ID field of the request message. Display Name: Opp Referece ID Code of the sedig service provider. This is icluded i all messages set from the local system to the peer system. Display Name: Seder Name Code of the receivig service provider. This is icluded i all messages set from the local system to the peer system. Display Name: Recipiet Name Idetifier of the ewly costructed message. The message text is retrievable usig the idetifier. Display Name: Message ID Startig telephoe umber i a Service Delivery Platform order. Display Name: Startig Number Edig telephoe umber i a Service Deliver Platform order. Display Name: Edig Number Implemetig Oracle Number Portability 41

56 Settig Profile Optios Default Work Items i Oracle Number Portability Note: These work items are optioal. You chose whether or ot to load the default work items durig applicatio istallatio. The table followig provides a summary of the seeded work items provided with Oracle Number Portability. These work items eed to be customized to meet the eeds of your istallatio of the applicatio.applicatios. Work Items Seeded by Oracle Number Portability Work Item Iteral Name Descriptio Cacel Discoect Portig Request from Order Etry Cacel Modify Portig Request from Order Etry Cacel Portig Request from Order Etry Charge New Operator for Portig Request Create or Modify Ported Number(s) CANCEL_DISC_PORT_REQ_FROM_OMS CANCEL_MODIFY_PORT_FROM_OMS. CANCEL_PORT_REQ_FROM_OMS REC_RECEIVE_CHARGING_NOTIF. PROVISION_PORTED_NUMBER. Customer cotacts curret operator to cacel a discoect subscriptio request. Customer cotacts ew operator to cacel a modificatio previously submitted o a portig request. Customer cotacts ew operator to cacel a portig request. Door Operator charges recipiet operator for the port-out trasactio. Create or Update etwork elemets with ew portig data received from Number Registratio Ceter. Delete Ported Number(s) DELETE_PORTED_NUMBERS. Remove portig data from etwork elemets provisioed earlier. This may be i respose to a broadcast received from Number Registratio Ceter to carry out this activity. Discoect Portig Request from Order Etry Hold Portig Request from Order Etry Hold Portig Request from other Operator Iquire Door Operator for Portig Out DISC_PORT_REQ_FROM_OMS HOLD_PORT_REQ_FROM_OMS. HOLD_PORT_REQ_FROM_OPERATOR. PORTING_INQUIRY_FROM_OPERATOR. Customer cotacts curret operator to discoect subscriptio. Customer cotacts ew operator to place a portig request o hold. Hold Portig Request received from other operator. Door operator determies whether portig iquiry request should be approved or rejected. Implemetig Oracle Number Portability 42

57 Settig Profile Optios Work Items Seeded by Oracle Number Portability Work Item Iteral Name Descriptio Iquire Recipiet Operator for Portig I Load, Disaster Recovery & Backup of Local Database Modify Portig Request from Operator Modify Portig Request from Order Etry Number Rage Split Request from Order Etry Portig Notificatio Cocurrece Portig Order iitiated by Recipiet Operator PORTING_INQUIRY_FROM_OMS LOAD_DISASTER_RECOVERY_BACKUP MODIFY_PORT_REQ_FROM_ OPERATOR. MODIFY_PORT_REQ_FROM_OMS. NUMBER_RANGE_SPLIT RECEIVE_CONCURRENCE PORTING_ORDER_FROM_OMS New Operator receives portig iquiry from customer care. Sychroize local database with Number Registratio Ceter. Modifies the Portig Request o receivig such a request from the other operator. Customer cotacts ew operator to modify a portig request. Number Rage Split declared by a regulatory board. Door Operator ad Recipiet Operator receive cocurrece otificatio from Number Registratio Ceter for a portig trasactio. Recipiet Operator receives portig order from Customer Care. Query Portig Data QUERY_REFERENCE_DATA. Query Number Registratio Ceter for portig data. Reject Portig Request PORTING_NOTIFICATION_REJECTION. Door Operator ad Recipiet Operator receive rejectio otificatio from Number Registratio Ceter for a portig trasactio. Remid Operator for Portig Respose Respod to Portig Order received by Door Operator Trasfer Number Rage Holder from Order Etry PORTING_NOTIFICATION_REMINDER. PORTING_ORDER_FROM_OPERATOR. TRANSFER_NUMBER_RANGE_HOLDER Number Registratio Ceter remids operator that a respose is required to proceed with the portig process. Door Operator respods to a Portig Request. Trasfer Number Rage Holder declared by a regulatory board. Implemetig Oracle Number Portability 43

58 Settig Profile Optios Work Item Parameters Work Item parameters act as a parameter pool for all the defied Work Items i SDP. New SDP Work Items ca be defied usig the existig parameters i the pool. New Work Item parameters ca also be added to defie ew Work Items or exted existig Work Items. The table below gives the list of Work Items pre-cofigured by SDP for Number Portability. Every NP Workflow executes withi the cotext of a SDP Order s WorkItem process. Each order has a uique id called the ORDER_ID ad is supplied ad maitaied by the SDP egie. Similarly, each WorkItem too has a uique id called the WORKITEM_INSTANCE_ID which agai is supplied by the SDP s order processig egie. Orders ca be submitted to the SDP-NP system either through the user iterface or through a message. I the latter case, the message is processed ad submitted as a order to the SDP-NP System as part of the message s processig logic. The above figure shows the two possible ways i which a NP workflow could be kicked off i.e. through the Customer Care (i.e. UI) or the processig logic. Subsequetly, the order tracked by the order moitor, which starts-up the NP workitem workflow givig it a uique id. As part of the busiess process executio, the workflow could execute a fulfillmet actio through the SDP s provisioig egie ad waits for the respose to get the cotrol back. At the ed of the workflow, the cotrol is retured back to the order moitor. See Appedix C: Work Item Parameters Implemetig Oracle Number Portability 44

59 Settig Profile Optios Maitaiig State I NP Applicatios l NP Work Item Flow through Customer Care Order Moitor Start NP Work Item Start NP Work flow Order Moitor Processig Logic Execute FA (& retur) How is State Maitaied i NP Applicatios? All NP busiess processes ivolve messagig trasactios with exteral systems. So, durig a busiess process, the workflow could Sed messages ad also await for resposes. The messages awaited could be either a immediate (positive or egative) ack to a earlier message set by this workflow or could be some message which ca be aticipated durig the busiess process. I either case, every workflow eeds to maitai state of the trasactio while waitig for exteral messages. This is doe by havig a way to idetify the workflow trasactio with some uique idetifier. This uique idetifier is the REFERENCE_ID. To accommodate a similar idetifier for the exteral system too, we have a OPP_ REFERENCE_ID (opposite party s Referece Id). Every icomig or outgoig NP message must cotai these two (i.e. REFERENCE_ID ad OPP_REFERENCE_ID) as madatory elemets i the header. While awaitig a respose from the exteral system, the workflow is uiquely idetified by the combiatio of a) Message (code) awaited AND b) Referece Id of the trasactio Oce this combiatio is matched, the appropriate workflow is called-back by the evet maager. Implemetig Oracle Number Portability 45

60 Settig Profile Optios How to decide o the Referece Id for a NP workflow? The best choice for the Referece Id would be some uique idetifier provided by a system which is exteral to NP. The referece id could be a Portig Id if that uiquely idetifies a portig trasactio workflow ad is guarateed to be part of the resposes received from the exteral system. I the absece of ay such idetifiers from the exteral system, the NP busiess aalyst must be able to arrive at such a idetifier. Sice the WORKITEM_ INSTANCE_ID is uique for that workflow, it could be a cadidate for the Referece id. Aother choice for referece id could be the ORDER_ID if o two workitems withi the same order would register for the same message at the same time. Please ote that the i the absece of ay sigle value for the referece id, the workflow ca use a cocateatio of values e.g. it could be the cocateatio of the startig umber, edig umber ad portig id with some delimiters. The workflow gets called back by the evet maager whe the respose arrives if the received message s REFERENCE_ID field matches the registered referece id. To get the right workflow which maps to this (msg code + referece id) combiatio, the evet maager searches through all the registratios. This searchig by the evet maager happes after the received message is validated. So, it eeds to be esured that at the ed of the validatio, the message header s REFERENCE_ID matches the registered referece id for the received message. I cases, whe the received message is ot request s respose but aticipated alog the NP s busiess flow the exteral system would have o idea of our Referece Id. I such cases, the message validatio logic could hadle the populatig of the header s REFERENCE_ID with the registered value. This way, the evet maager would still be able to map the received message to the right workflow. See Appedix B: Sample Workflows Implemetig Oracle Number Portability 46

61 Settig Profile Optios Adapters i Oracle Number Portability You cofigure a adapter to iteract with the exteral system ad to route messages to ad from the exteral system appropriately. You cofigure a adapter by specifyig its attributes. The applicatio comes with the file adapter already defied. This adapter eables messages to be passed to local files, or set to a remote locatio usig the provided FTP cliet. Outboud Messages For outboud messages, the adapter receives the message from the Oracle Advaced Queue, ad geerates the chael iformatio accordigly. Accordig to the eed, the adapter seds the message to oe of the followig chaels: A local file A remote system (usig File Trasfer Protocol) Iboud Messages For iboud messages, the adapter acts like a server. It retrieves the message by moitorig a desigated file directory. It the pushes the messages i the files it retrieves to the queue. MSG_SERVER is the cosumer for these iboud messages. Chaels A chael defies the path a messages takes durig message trasfer from, or to, a clear destiatio. You ca oly have oe chael ope per message at ay give time. If you wat to operate a ew chael, the you must close the old chael. For example, if you ope a file ad sed messages to it, the you must close that file before you ca ope aother file chael. Implemetig Oracle Number Portability 47

62 Settig Profile Optios File Adapter Attributes The table followig lists the attributes you must defie for a file adapter. File Adapter Attributes Display Name Iteral Name Descriptio Home Directory HOMEDIR The directory o the local machie where the file is to be created. I Directory IN_ARCHIVE_DIR The directory to which the file is to be archived after the adapter reads it. IP Address IP_ADDRESS IP address of the remote machie to which the file is to be set. Out Directory OUT_ARCHIVE_DIR The directory i which the file is to be archived after the file trasfer has completed. Password PASSWORD Password for autheticatio. PORT PORT The port o which the remote FTP server is ruig. The stadard port is 21. Remote Directory REMOTEDIR The directory o the remote machie where the file is to be placed. Sca Directory SCANDIR The directory from which files are read ad set to the applicatio for processig. User ID USER_ID The user ID for the autheticatio. Fulfillmet Elemet Types i Oracle Number Portability Every fulfillmet elemet belogs to a fulfillmet elemet type group. The applicatio supports the creatio of ew elemet types, if ecessary. Typically, you eed fulfillmet elemet types that correspod to the followig categories: SCP (service cotrol poit) SSP (sigal switchig poit) STP (sigal trasfer poit) types SP (service providers) gateways NRC (umber registratio ceter) gateways Implemetig Oracle Number Portability 48

63 Settig Profile Optios Predefied Fulfillmet Elemet Types The Oracle Number Portability applicatio comes with a umber of predefied fulfillmet elemet types. The table followig lists these predefied elemet types. Predefied Elemet Types i Oracle Number Portability Elemet Type BILLING_GATEWAY DIRECTORY_GATEWAY NRC_GATEWAY SCP SP_GATEWAY SSP STP Descriptio Refers to billig system gateway Refers to Directory assistace gateway Refers to the Number Registratio Ceter gateway Refers to the LNP database for all service cotrol poits Refers to messagig gateways for remote systems of other Service providers Refers to sigal switchig poit Refers to sigal trasfer poit Note: If the fulfillmet elemet is a etwork elemet of type SCP, SSP, or STP, the you must defie the umber rages served by this etwork elemet for a give feature type. Fulfillmet Elemets i Oracle Number Portability A fulfillmet elemet is either oe of the followig: A etwork elemet A exteral system For example, Service Switchig Poits ad Sigalig Trasfer Poits are types of etwork elemets typically provisioed for umber portability. Implemetig Oracle Number Portability 49

64 Settig Profile Optios Fulfillmet Elemets as Network Elemets You cofigure each etwork elemet as a fulfillmet elemet. This process icludes specifyig the followig items for the fulfillmet elemet. Its etwork ID Its Network Elemet Type Its attributes Its software versios The supported commuicatio protocols The adapter type Fulfillmet Elemets as Exteral Systems Every service provider (exteral system) with which the applicatio iteracts must have a correspodig fulfillmet elemet created for it. This fulfillmet elemet represets the cofiguratio setup for the gateway to that exteral system. You must defie the appropriate fulfillmet elemet i order for the applicatio to iteract with a exteral system. You must cofigure adapters that ca iteract with that exteral system. Adapters route messages set to ad from the exteral system appropriately. Implemetig Oracle Number Portability 50

65 Settig Profile Optios Uderstadig Fulfillmet Actios Fulfillmet actios apply fulfillmet procedures to fulfillmet elemets. Each fulfillmet elemet has a software versio ad a adapter assiged to it, ad is of a certai fulfillmet elemet type. From this iformatio, the fulfillmet actio determies which fulfillmet procedure to perform o this fulfillmet elemet. Oe fulfillmet actio is writte for every actio that is performed o a fulfillmet elemet. A fulfillmet actio acts upo oly a sigle fulfillmet elemet. (This is true at rutime oly.) A fulfillmet actio ca act o multiple fulfillmet elemet types, however, by specifyig for each elemet type the adapter, the software versio, ad the procedure to be applied. If fulfillmet actios are defied for use i Oracle Number Portability, the they are assiged iteral ames such as Provisio Number Portability, De-provisio Number Portability, or Modify Number Portability. Display ames correspod to these iteral ames. A user may defie fulfillmet actios, as well. Predefied Fulfillmet Actios Oracle Number Portability comes with a umber of fulfillmet actios predefied. I most cases, it is ot ecessary to defie ew actios. These predefied fulfillmet actios are listed i the followig table. Fulfillmet Actios Predefied i Oracle Number Portability Deprovisio Provisio Modify DEPROVISION_CLASS PROVISION_CLASS MODIFY_CLASS DEPROVISION_CNAM PROVISION_CNAM MODIFY_CNAM DEPROVISION_ISVM PROVISION_ISVM MODIFY_ISVM DEPROVISION_LIDB PROVISION_LIDB MODIFY_LIDB DEPROVISION_NP PROVISION_NP MODIFY_NP DEPROVISION_RN PROVISION_RN MODIFY_RN DEPROVISION_WSMSC PROVISION_WSMSC MODIFY_WSMSC Implemetig Oracle Number Portability 51

66 Settig Profile Optios Fulfillmet Actios Oracle Number Portability 11i also provides a predefied set of fulfillmet actios which ca be used to build a umber portability applicatio. Each Fulfillmet actio performs oe of the three basic operatios i.e., Provisio, De-Provisio or Modify the appropriate feature o a chose fulfillmet elemet. A Fulfillmet actio ca be executed from Workflow. Sice a fulfillmet actio maps to oe or more Fulfillmet Procedures, the developer is required to write the Fulfillmet Procedures. Refer to the provisioig guide for more iformatio o Fulfillmet Actios ad Fulfillmet Procedures. The followig sectio describes the Fulfillmet Actios shipped as part of the NP 11i. Fulfillmet Actio Name Iteral Name Display Name Provisio NP PROVISION_NP Provisio NP Fulfillmet Elemets. This will iclude the SSP, STP ad SCP. Deprovisio NP DEPROVISION_NP Deprovisio NP Fulfillmet Elemets Modify NP MODIFY_NP Modify NP Fulfillmet Elemets Provisio CLASS PROVISION_CLASS Provisio CLASS Fulfillmet Elemets Deprovisio CLASS DEPROVISION_CLASS Deprovisio CLASS Fulfillmet Elemets Modify CLASS MODIFY_CLASS Modify CLASS Fulfillmet Elemets Provisio CNAM PROVISION_CNAM Provisio CNAM Fulfillmet Elemets Deprovisio CNAM DEPROVISION_CNAM Deprovisio CNAM Fulfillmet Elemets Modify CNAM MODIFY_CNAM Modify CNAM Fulfillmet Elemets Provisio LIDB PROVISION_LIDB Provisio LIDB Fulfillmet Elemets Deprovisio LIDB DEPROVISION_LIDB Deprovisio LIDB Fulfillmet Elemets Modify LIDB MODIFY_LIDB Modify LIDB Fulfillmet Elemets Implemetig Oracle Number Portability 52

67 Settig Profile Optios Provisio ISVM PROVISION_ISVM Provisio ISVM Fulfillmet Elemets Deprovisio ISVM DEPROVISION_ISVM Deprovisio ISVM Fulfillmet Elemets Modify ISVM MODIFY_ISVM Modify ISVM Fulfillmet Elemets Provisio WSMSC PROVISION_WSMSC Provisio WSMSC Fulfillmet Elemets Deprovisio WSMSC DEPROVISION_WSMSC Deprovisio WSMSC Fulfillmet Elemets Modify WSMSC MODIFY_WSMSC Modify WSMSC Fulfillmet Elemets Provisio RN PROVISION_RN Provisio RN Fulfillmet Elemets Deprovisio RN DEPROVISION_RN Deprovisio RN Fulfillmet Elemets Modify RN MODIFY_RN Modify RN Fulfillmet Elemets Uderstadig Fulfillmet Procedures A fulfillmet procedure is composed of specific commads that are set to a fulfillmet elemet whe a fulfillmet actio is ivoked. Examples of such commads might be to ope a Telet sessio or to provide elemet-specific routig commads to the elemet. 3. A fulfillmet procedure comprises the followig elemets: A fulfillmet elemet type A adapter The software versio to be used o this fulfillmet elemet type The fulfillmet actio to be performed Implemetig Oracle Number Portability 53

68 Settig Profile Optios Creatig a Fulfillmet Elemet The followig provides a overview of the steps required to implemet a SDP Fulfillmet Actio from withi a User Defied Workflow. 1. Please read ad follow the process outlied i Cofiguratio HowTo, Service Delivery Platform, User Defied Workflow before cotiuig. 2. Usig SDP, defie a Fulfillmet Elemet (FE) Type ad Fulfillmet Elemet (FE) 3. Defie a Fulfillmet Actio (FA) ad Fulfillmet Procedure (FP) 4. Create a Fulfillmet Elemet (FE) adapter 5. Usig Oracle Workflow (WF) Builder, ope the data store defied i step 1 above 6. Add a SDP Fulfillmet Actio (FA) to the WF process diagram Process Details The followig provides a detailed descriptio of the steps defied i sectio Process Overview Usig SDP 1. Logo to SDP 2. Access the Fulfillmet Elemet scree from the Service tab Steps to Defie a Fulfillmet Elemet 1. Click Add Specify a Display Name Specify a Iteral Name Defie a Fulfillmet Elemet Type Click Defie Types from the Defie Fulfillmet Elemets scree Click Add Specify a Display Name Specify a Iteral Name Specify a Descriptio Implemetig Oracle Number Portability 54

69 Settig Profile Optios 2. Click Attributes tab Specify a Display Name Specify a Display Seq Specify a Iteral Name Specify a Descriptio Specify a Default Value Idicate if the Default Value is hidde or ot Note: Repeat the above poits for the umber of Attributes required for the Fulfillmet Elemet (FE) Type.. 3. Click Software tab Specify a Display Name Specify a Iteral Name Select the required Adapter Type from the LOV Specify a Descriptio Defie a Coect procedure for the Fulfillmet Elemet (FE) Type Defie a Discoect procedure for the Fulfillmet Elemet (FE) Type Implemetig Oracle Number Portability 55

70 Settig Profile Optios 4. Click OK Note: The Defie Fulfillmet Elemets scree will be displayed. Select a value from the Type LOV. The value selected here will be the Fulfillmet Elemet (FE) Type defied i step 4 above. Specify a Descriptio Specify a Mi coectio value Specify a Max coectio value Note: The Mi ad Max coectio values idicate the umber of Fulfillmet Elemet Adapters that ca be created for the Fulfillmet Elemet (FE). 5. Click SW Versio Select a value from the Software Versio (Adapter Type) LOV. The value selected here will be the Fulfillmet Elemet (FE) Type software versio defied i step 4 above. Specify a Begi Date Defie a Coect procedure for the Fulfillmet Elemet (FE). You ca also select the Coect procedure defied for the Fulfillmet Elemet (FE) Type i step 4 above. Defie a Discoect procedure for the Fulfillmet Elemet (FE). You ca also select the Discoect procedure defied for the Fulfillmet Elemet (FE) Type i step 4 above. 6. Click Attributes tab 7. Click OK Specify the required attributes for the Fulfillmet Elemet (FE). Specify a Value for the attribute 8. Access the Fulfillmet Actios (FA) scree from the Service tab 9. Defie a Fulfillmet Actio (FA) Implemetig Oracle Number Portability 56

71 Settig Profile Optios 10. Click Add Specify a Display Name Specify a Iteral Name Specify a Versio Specify a Descriptio Defie a Fulfillmet Elemet (FE) Routig procedure. This procedure should make referece to the Fulfillmet Elemet (FE) that was defied i sectio Usig SDP, step Click Parameters Select the required parameters from the Available Parameters pick list For each parameter selected, specify a default value if required 12. Click Fulfillmet Procedures Select a value from the Fulfillmet Elemet (FE) Type LOV. The value selected here will be the Fulfillmet Elemet (FE) Type defied i sectio Usig SDP, step 4. Select a value from the Software Versio (Adapter Type) LOV. The value selected here will be the software versio for the Fulfillmet Elemet (FE) Type defied i sectio Usig SDP, step Click OK Defie a Fulfillmet Procedure (FP) for the Fulfillmet Actio (FA) Implemetig Oracle Number Portability 57

72 Settig Profile Optios Steps to Create a Fulfillmet Elemet (FE) adapter 1. Access the Coectio Maagemet Utility scree from the Admiistratio tab Select the Fulfillmet Elemet (FE) that was defied i sectio Usig SDP, step 3 Select the Adapter tab Click New 2. Click OK Specify a Name 3. After clickig OK, SDP will start a adapter for the Fulfillmet Elemet (FE). The above scree shows the adapter with a Curret Status of idle 4. Close the SDP scree Implemetig Oracle Number Portability 58

73 Settig Profile Optios Usig Oracle Workflow Builder 1. Start the Oracle Workflow Builder 2. Ope the data store that requires a SDP Fulfillmet Actio (FA). 3. Esure that the followig SDP item types are icludig withi the data store opeed i step 2 above: SDP Lookup Codes SDP Stadard 4. Ope the WF process diagram that requires a SDP Fulfillmet Actio (FA). Double-Click the required process. Note: I the sample screes that follow, referece will be made to a dummy process called Test FA Process. 5. Drag the Execute Fulfillmet Actio fuctio from the SDP Stadard Item Type ito the Process Diagram 6. Create the trasitios betwee the Execute Fulfillmet Actio ad other activities i the WF process diagram Note: The Execute Fulfillmet Actio has the followig three result types which eeded to be mapped: FA Status: Aborted FA Status: Error FA Status: Success Implemetig Oracle Number Portability 59

74 Settig Profile Optios Set the properties of the Execute Fulfillmet Actio activity 1. Click the Node Attributes tab Specify the FA Name attribute value IMPORTANT: The FA Name attribute must be the same as the Iteral Name defied for the Fulfillmet Actio (FA) i sectio Usig SDP. Specify the FE Name attribute value IMPORTANT: If The FE Name attribute must be the same as the Iteral Name defied for the Fulfillmet Elemet (FE) i sectio Usig SDP. 2. Click OK Geographic Areas Defied Geographic areas are used i Oracle Number Portability for the followig purposes: To idetify the areas covered by a Number Registratio Ceter. The applicatio uses this iformatio to determie to which Number Registratio Ceter a message is to be set. To idetify the areas covered by a umber rage. The geographic area of a umber rage ca be set to the Number Registratio Ceter wheever a port order is submitted. To idetify the areas that correspod to a routig umber. To idetify the areas covered by a Service Provider. Implemetig Oracle Number Portability 60

75 Settig Profile Optios Elemets of Geographic Area Defiitio You ca create ew geographic areas or modify a existig area to meet your busiess eeds. Each geographic area cotais the followig items: Area type: Geographic area types are user-defied. You must defie the area type before begiig to defie the geographic area. The applicatio comes with some types already pre-defied. Code: The code for a geographic area ca be defied by a publicly available directory. Name: The ame of the geographic area describes the physical area ivolved. For example, the ame of a city or a regio. Note: I defiig a geographic area, you ca specify that other geographic areas are its childre. Thus, if you wat to create a hierarchy of geographic areas, the you do this by buildig the hierarchy from the top dowwards startig with the largest geographic areas. Implemetig Oracle Number Portability 61

76 Settig Profile Optios Service Providers I order to provide umber portability from oe service provider to aother, each of the service providers must be set up i Oracle Number Portability. This iformatio is used by the Service Order Admiistrator ad the Service Maagemet System to create ad activate service orders as they are received. The precise tasks that you perform for a service provider deped o the purpose of your istallatio of Oracle Number Portability. The followig table lists the three usage types for the applicatio ad describes the kid of iformatio that you eed for each type. Types of Oracle Number Portability Istallatios Istallatio Purpose Idividual Service Provider Number Registratio Ceter Tasks You must set up the followig: Full iformatio for yourself Basic iformatio for all other service providers with whom you expect to iteract You must set up the followig: Full iformatio for yourself Iformatio for all service providers i your regio Implemetig Oracle Number Portability 62

77 Settig Profile Optios Subscriptio Versios Subscriptio versios are used to maitai the status of portig requests across orders. There are two types of subscriptio versios. They are: Order Subscriptio Versios: Typically created by the recipiet service provider, door service provider, ad cetral system durig the Service Order Admiistratio phase of the portig process. Network Subscriptio Versios: Typically created by the recipiet service provider, door service provider, ad cetral system durig the Service Maagemet System phase of the portig process. The key compoets of a Order Subscriptio Versio differ slightly from the key compoets of a Network Subscriptio Versio. Order Subscriptio Versios versus Network Subscriptio Versios Compoet Order Subscriptio Network Subscriptio Phase Idicator Yes No Telephoe Number Yes Yes Routig Number Yes Yes Status Yes No Portig ID Yes Yes Customer Yes No Chage Cause Code Yes No Recipiet Service Provider Yes No Recipiet Service Provider Due Date Yes No Door Service Provider Yes No Door Service Provider Due Date Yes No Mediator Service Provider (e.g., Cetral System) Yes Yes Provisioig Map & Provisioig Status No Yes Oracle Number Portability creates a subscriptio versio for each idividual telephoe umber. Implemetig Oracle Number Portability 63

78 Settig Profile Optios For example, if a rage of telephoe umbers is ported such as through , the applicatio creates three idividual subscriptio versios, oe for each umber ported. Notes I geeral, the followig is true about the two types of subscriptio versios: 1. Participats typically do ot have a Order Subscriptio Versio for a give telephoe umber. 2. Door ad Recipiet Service Providers typically have both a Order Subscriptio Versio ad a Network Subscriptio Versio for a give telephoe umber. 3. Cetral Systems typically have oly Order Subscriptio Versios. Order Subscriptio Versios A order subscriptio versio is typically created by the recipiet service provider, door service provider, ad cetral system durig the Iitiatio phase of the portig process. Recipiet Service Provider After a customer calls a ew service provider to request service for his/her existig telephoe umber, the followig evets geerally occur: The recipiet service provider creates a order with a portig request for the customer s telephoe umber. This order is passed from the orderig system to the Service Delivery Platform. The Service Delivery Platform recogizes the portig request o a specific lie item of the order ad triggers Oracle Number Portability. Oracle Number Portability executes the customized busiess process for a port-i request ad creates a portig order called a Order Subscriptio Versio. The recipiet operator also seds a outgoig message to otify the cetral system about the portig request. The Order Subscriptio Versio is used by the recipiet service provider to maitai status of the portig request throughout its life cycle. Implemetig Oracle Number Portability 64

79 Settig Profile Optios Cetral System Whe the cetral system receives a icomig message from the recipiet operator for a ew portig request, the followig evets geerally occur: The cetral system creates a portig order called a Order Subscriptio Versio. The cetral system also seds a outgoig message to otify the door service provider about the portig request. The Order Subscriptio Versio is used by the cetral system to maitai status of the portig request throughout its life cycle. Door Service Provider Whe the door service provider receives a icomig message from the cetral system for a port-out request for its existig telephoe umber(s), the followig geerally occurs: The door service provider creates a portig order called a Order Subscriptio Versio. The Order Subscriptio Versio is used by the door service provider to maitai status of the portig request throughout its life cycle. Portig ID The Order Subscriptio Versio for the recipiet operator, door operator ad cetral system is idetified by a sigle portig idetifier, the Portig ID umber. This Portig ID is typically assiged by the cetral system. After assigig a Portig ID, the cetral system otifies both the recipiet operator ad the door operator of the portig ID through messagig. A portig ID ca referece multiple Subscriptio Versios. The applicatio does ot require a uique portig ID for Subscriptio Versios. Implemetig Oracle Number Portability 65

80 Settig Profile Optios Network Subscriptio Versios A etwork subscriptio versio is typically created by the recipiet service provider, door service provider ad participat service providers durig the Activatio phase of the portig process. Recipiet Service Provider After a portig request is received, the followig evets geerally occur: Prior to the due date of a portig request, the recipiet operator must usually make chages to its etwork to activate service for the ew customer. At this time, the recipiet operator creates a Network Subscriptio Versio usig the same Portig ID as the oe used to create the Order Subscriptio Versio. The Network Subscriptio Versio is ow used to maitai details ad status of each etwork elemet that has bee updated ad the umber portability data used to update each etwork elemet. Door Service Provider After a portig request is received, the followig evets geerally occur: Prior to the due date of a portig request, the door operator must also make chages to its etwork to de-activate service for the ew customer ad trasfer all icomig calls to the recipiet service providers etwork. At this time, the door operator creates a Network Subscriptio Versio usig the same Portig ID as the oe used to create the Order Subscriptio Versio. The Network Subscriptio Versio is ow used to maitai details ad status of each etwork elemet that has bee updated ad the umber portability data used to update each etwork elemet. Implemetig Oracle Number Portability 66

81 Settig Profile Optios Participat Service Providers After a portig request is received, the followig evets geerally occur: O the due date or withi a specified time period after the portig due date, the participat service providers epochally receives a broadcast from the cetral system. The purpose of the broadcast is to otify all participat service providers that are affected by the customers port to make the ecessary chages to their etwork elemets so that all icomig calls to the customer are ow delivered to the ew service provider istead of the old service provider. For example, this broadcast message ca cotai the Portig ID of the Order Subscriptio Versio created by the cetral system durig the Service Maagemet System phase of the portig process. At this time, the participat service providers create a Network Subscriptio Versio usig the Portig ID received i the broadcast. The Network Subscriptio Versio is ow used to maitai details ad status of each etwork elemet that has bee updated ad the umber portability data used to update each etwork elemet. Portig ID The Network Subscriptio Versio for the recipiet operator, door operator ad participat service providers is uiquely idetified by a sigle portig idetifier. This Portig ID is typically the same Portig ID that was assiged by the cetral system to uiquely idetify the correspodig Order Subscriptio Versio. Implemetig Oracle Number Portability 67

82 Settig Profile Optios Defiig a Service Provider To defie a service provider, perform the followig steps. Prerequisites Noe Steps 1. I the Navigator, choose Setup > Service Defiitios > Service Providers. 2. Click the New ico o the toolbar to create a ew service provider. 3. Eter a ame for the ew service provider. 4. Use the Details tab to eter basic iformatio about the service provider. 5. Use the Cotacts tab to eter cotact iformatio for the service provider. Note that it is possible to eter more tha oe cotact for a service provider. 6. Use the Numbers tab to eter a umber rage for each service provider. Note that it is possible for oe service provider to ow a particular umber rage, but they may have chose to assig it to aother service provider. For the purposes of umber portability, Oracle Number Portability always uses the assiged service provider. 7. Use the Filters tab to eter umber filters for the service provider. A filter is the list of telephoe umber rages i which a service provider is iterested. You eter this iformatio to create filters so that a Number Registratio Ceter ca broadcast your subscriptio versio iformatio selectively. 8. Use the Coverage tab to eter geographic areas supported by a Number Registratio Ceter service provider. If you are settig up a Number Registratio Ceter as oe of the service providers o your system, the you must provide iformatio about those geographic areas supported by this Number Registratio Ceter. You do ot have to perform this step for other types of service provider. If you do ot see the desired area ame i the Available box, eter the ame i the Filter field ad click Fid to search for it. If the area is ot defied yet, click New Geographic Area to ope the Geographic Area Setup widow ad the add it. See Defiig a New Geographic Area for details, if ecessary. Implemetig Oracle Number Portability 68

83 Settig Profile Optios 9. Use the Routig# tab to eter routig umbers for the service provider. Each service provider desigates certai umber rages for the purpose of routig ported calls. These routig umbers provide the ecessary iformatio for routig a ported call. The umbers are mapped to the service provider s etwork elemets ad to the Oracle Number Portability subscriber s dialig umber. Routig umbers are provided by the Number Registratio Ceter for service providers other tha you or for those service providers o whose behalf you act. All other service provider s etries are added to ad deleted from this table upo istructio from the Number Registratio Ceter. 10. Click the Adapter Cofiguratio tab to eter iformatio about a service provider adapters. Click New Adapter Cofiguratios to create a ew fulfillmet elemet or to modify a existig fulfillmet elemet, if ecessary. 11. Close the widow. You are prompted to save your chages. Defiig a Portig Status Type A service order may have oe of a umber of differet statuses throughout its life cycle. You ca defie statuses that reflect the termiology ad busiess processes of your orgaizatio. Prerequisites Each portig status must be associated with oe of the four phases or statuses. Iquiry Orderig Active Old Implemetig Oracle Number Portability 69

84 Settig Profile Optios Steps 1. I the Navigator, choose Setup > Service Defiitios > Portig Status Types. 2. Click the New ico o the toolbar to create a ew portig status type. 3. Eter a value at the left i the Portig Status Code field. 4. Eter a display ame ad brief descriptio for the ew status. 5. Select a phase for the ew status. 6. Eter the desired display sequece. 7. Check the Active box to eable the use of this status by Oracle Number Portability. 8. Close the widow. You are prompted to save your chages. Defiig Number Rages ad the Network Map You use the Network Map form widow to perform the followig two tasks: Defiig the served umber rages for a give etwork elemet Defiig a etwork map Defiig the Served Number Rages Perform the followig steps to defie the served umber rages for a give etwork elemet. Prerequisites You must defie a fulfillmet elemet before you ca associate a rage of telephoe umbers to it. Implemetig Oracle Number Portability 70

85 Settig Profile Optios Steps 1. I the Navigator, choose Setup > Iterface Defiitio > Fulfillmet Elemets. 2. Select a fulfillmet elemet from the list at the left. 3. Click Network Map. The Network Map for <fulfillmet elemet> widow opes (where <fulfillmet elemet> is the ame that you chose earlier. 4. Select the Served Number Rages tab. 5. Eter a start ad a ed umber to defie the rage of telephoe umbers with which this fulfillmet elemet is associated. 6. Chose a feature type from the list of values that matches your busiess process. 7. Select the check box for Primary if the defied umber rage is to be stored i the primary source for routig iformatio. 8. Select the check box for Active, if the defied umber rage is to be stored i the active database (as opposed to a backup system). 9. Close the Network Map widow. You are prompted to save your chages. Implemetig Oracle Number Portability 71

86 Settig Profile Optios Defiig a Network Map Prerequisites Noe Steps 1. I the Navigator, choose Setup > Iterface Defiitio > Fulfillmet Elemets. 2. Select a fulfillmet elemet from the list at the left. 3. Click Network Map. The Network Map for <fulfillmet elemet> widow opes (where <fulfillmet elemet> is the ame that you chose earlier. 4. Select the Associated Network Elemets tab. The iformatio i this tab is for future use ad is curretly read-oly. 5. Close the Network Map widow. Implemetig Oracle Number Portability 72

87 Settig Profile Optios Messagig i Oracle Number Portability Oracle Number Portability uses messages to commuicate with exteral systems ad iitiate ew orders i Service Delivery Platform. For example: Oracle Number Portability seds a outgoig message requestig a umber port with the Cetral System. The Oracle Number Portability workflow the waits for a iboud message that cofirms the request to port. This use of messagig itegrates the use of workflows with exteral coditioal elemets. Messages ca trigger a process, or set of processes i a applicatio. Applicatios sed ad receive messages asychroously usig the Evet Maager. Messages Defied Messages are used to commuicate betwee applicatios ad systems. Service Delivery Platform messages are defied i the idustry-stadard XML format. Whe a message is compiled, the followig fuctios are created: Sed() Publish() Validate() Process() Default_Process() Create_Msg() These fuctios are used to commuicate with the Number Registratio Ceter ad other service providers as well as with ay other exteral system or iteral Operatioal Support Systems. Also, messages ca trigger a set of processes iterally withi the system. Message Defiitio You defie messages i oe of two ways: You ca select from a set of predefied ad available messages that are preceded i Oracle Number Portability. You ca build ad defie ay required messages through the imessage Studio. Implemetig Oracle Number Portability 73

88 Settig Profile Optios Message Elemets A message comprises oe or more message elemets. A message elemet cosists of a set of attributes: Parameters Default Name Madatory Data Type Sequece Legth For example, area may be a message elemet composed of legth ad width. The message elemet ame is used as a tag withi the XML message. Each message elemet has a data source which must be defied. Messages versus Evets The table followig lists the differeces betwee messages ad evets. Messages versus Evets Type Message Evet Descriptio A request to, or a reply from, a sigle pre-defied destiatio Broadcast otificatio to zero or more destiatios that eed ot be specified util rutime Implemetig Oracle Number Portability 74

89 Settig Profile Optios How the Evet Maager Hadles Messages The Evet Maager hadles all messages eterig the applicatio system. Icomig messages are oe of the followig types: Request messages Resposes to request messages Evet otificatios from remote systems Remote applicatios sed request messages ad register for respose messages with the Evet Maager. The remote applicatios use a Oracle Number Portability API to register for messages. Whe a message arrives, the Evet Maager delivers the message to all registered applicatios after executig the validatio ad processig logic defied for the message. If o applicatio has registered for a message, the applicatio s default processig logic for that message is executed after message validatio. Message Processig by the Evet Maager The Evet Mager performs the followig actios upo arrival of a ew message i the system. 1. It first retrieves the message from the Iboud Message queue or the Iteral Evets queue. 2. It executes the validatio logic for the message. 3. It the searches the callback registratio table to determie all workflow istaces registered for the received message code ad referece ID combiatio. If a match is foud, the Evet Maager executes the icomig processig logic for the message. If o matches are foud, the Evet Maager executes the default processig logic for the message. It the retrieves the ext message from the Iboud Message queue ad starts the process over. 4. Fially, it attempts to deliver the message to the registered workflow istaces. If the message is ot successfully delivered, the message status is marked as failed for the registrat. This status ca be see i the Callback Registratio data. Implemetig Oracle Number Portability 75

90 Settig Profile Optios Cofigurig imessage Subscriptio Withi Oracle Number Portability, you ca set applicatios to be default subscribers to messages. This is cofigured i the imessage Subscribers utility. You ca also associate default subscribers with evets. For example, whe a message occurs, the Evet Maager esures that a outboud message is automatically set to the subscriber idetified by a fulfillmet elemet. Automatic Resposes If desired, you ca associate oe or more resposes with a evet. A respose is a ackowledgmet to a message. For example, valid message resposes for the message "Is this a existig customer?" are: "Yes, this is a existig customer." "No, this is ot a existig customer." These resposes are messages i themselves ad must be cofigured i the applicatio before they ca be liked as resposes to a message. Maually Drive Messagig There are also a variety of APIs available i Service Delivery Platform to facilitate custom subscriptio, de-subscriptio, equeueig ad dequeueig. Cosult the Oracle Developig XML-based Message Based Applicatios referece guide for a detailed defiitio of the available API calls. Implemetig Oracle Number Portability 76

91 Settig Profile Optios The imessage Studio Use the imessage Studio as a tool for developig message-based Service Delivery Platform applicatios. It provides the followig fuctioality: The ability to develop a message-based applicatio, while geeratig the code to costruct, publish, validate, ad process applicatio messages. The ability to compile ad test these messages. The ability to share messages betwee applicatios, allowig for their re-use i various applicatios. The meas to prevet redefiig the same message i various applicatios across the eterprise. The ability to geerate procedures through its APIs ad its ru-time messages. The meas to customize pre-processig of outboud messages ad the post-processig of icomig messages from the Evet Maager to exteral subscribers. The ability to defie a message set for a particular evet durig processig of a order withi the applicatio. The ability to costruct timers (delayed messages) for use withi the applicatio. The ability to defie messages i the XML idustry-stadard format. The ability to create a series of message processes to commuicate with exteral systems, Service Providers, ad iteral Operatioal Support Systems. Implemetig Oracle Number Portability 77

92 Settig Profile Optios Messages, Evets ad Timers You use the imessage Studio to create the followig message-based items: Messages Evets Timers The followig table lists the three types ad describes each oe. Messages, Evets ad Timers Type Messages Evets Timers Descriptio A sequece of text characters that are used for commuicatio betwee applicatio systems. Messages fall ito two categories: Messages for iteral applicatios Iteral applicatios ca register a PL/SQL callback procedure via the Evet Publisher, or through a API. Messages for exteral applicatios Exteral applicatios do ot register callback procedures, but have adapters ruig to relay the published evet to the remote system. Exteral applicatios ca register for a evet usig the default subscribers scree. Oracle Number Portability explicitly supports oly the XML format. Messages that are set to exteral systems ad that are received from exteral systems. Evets are published to both exteral ad iteral applicatios. Messages that have a time delay ad a duratio iterval associated with them. Implemetig Oracle Number Portability 78

93 Settig Profile Optios Timers Defied Timers i Service Delivery Platform are used to hadle evets or processes that must occur at specified time itervals withi the applicatio. I geeral, timers are used i either oe of two ways: To perform a task oce, after a delay To perform a task repeatedly, after a delay Note: Service Delivery Platform timers use the Oracle Advaced Queue to perform queue operatios. See the Oracle Advaced Queue documetatio set for more iformatio. Timers provide the ability to hadle evets or processes that have to occur at specified time itervals i busiess applicatios. Timers cosist of a delay ad iterval. The delay represets the amout of time to wait before startig a timer. The iterval represets the wait time for a timer. Timers maybe associated with a whole workflow process ( ie. Process Timer), a particular activity withi a workflow (ie Activity Timer) or a message (ie. Message Timer). Activity Timers A Activity Timer is used i cojuctio with a Workflow activity. The purpose of a Activity Timer is to provide the ability to set a pre-defied period of time i which a Workflow activity must be completed withi. For example, A Workflow activity could be defied to check the etwork capacity for a requested data service. The time period to perform the Workflow activity could be 30 miutes. A Activity Timer ca be associated with the Workflow activity to hadle the required busiess logic if the 30 miute timeframe for the activity is exceeded. Implemetig Oracle Number Portability 79

94 Settig Profile Optios Process Timers A Process Timer is used i cojuctio with a Workflow process. The purpose of a Process Timer is to provide the ability to set a pre-defied period of time i which a Workflow process must be completed withi. For example, A Workflow process could be defied to provide a requested data service. The time period to perform the Workflow process could be 1 day. A Process Timer ca be associated with the Workflow process to hadle the required busiess logic if the 1 day timeframe for the process is exceeded. Message Timers A Message Timer is used i cojuctio with a message. The purpose of a Message Timer is to provide the ability to set a pre-defied period of time i which a message ackowledgmet is received. For example, A Workflow process could be defied to setup a accout for a etwork service. A message is set to the associated etwork service admiistrator. If a reply is ot received i 30 miutes, the the timer message is published ad picked up by the Workflow activity that is Waitig for the Ackowledgmets. The ackowledgmet may be a message reply or a timer i which the workflow follows a path based o the message received. How Timers Work After a timer is defied, ad liked to a activity (a evet), or a message, oe of two thigs ca the happe: The timer ever expires The timer expires Implemetig Oracle Number Portability 80

95 Settig Profile Optios The Timer Never Expires The followig sequece of evets occurs if the activity to which a timer is liked completes ormally, as scheduled. 1. You use the imessage Studio to defie a timer ad associate it with a evet, or a message. 2. The Timer Maager equeues the message i the timer queue (the Oracle Advaced Queue). 3. At ru time, the Evet Maager treats the timer just like ay other message, except that timers are equeued with a delay ad iterval which specifies the iterval of time after which the message is available for dequeueig. 4. The activity (evet or message) to which the timer is liked completes ormally. 5. The workflow applicatio deletes ay timers related to the respose message. 6. Workflow processig cotiues. The Timer Expires The followig sequece of evets occurs if the activity to which a timer is liked does ot completes ormally, ad the timer expires. 1. You use the imessage Studio to defie a timer ad associate it with a evet, or a message. 2. The Timer Maager equeues the message i the timer queue (the Oracle Advaced Queue). 3. At ru time, the Evet Maager treats the timer just like ay other message, except that timers are equeued with a delay ad iterval which specifies the iterval of time after which the message is available for dequeueig. 4. The timer iterval expires. 5. The Timer Maager dequeues the message from the timer queue ad equeues it o the message queue. 6. Subscribers to this message periodically check the message queue for its presece. 7. Workflow processig cotiues. Implemetig Oracle Number Portability 81

96 Settig Profile Optios Process Overview The followig provides a overview of the steps required to implemet timers withi SDP. 1. Usig SDP, defie a Activity, Process, Message timer ad Message Ackowledgmet i imessage Studio 2. Geerate the required lookups represetig the timers defied i step 1 above 3. Usig Oracle Workflow Builder (WFB), create a ew data store based o the SDP workflow template 4. Defie a ew WF item type 5. Defied required attributes for the ew WF item type 6. Defie required fuctios for the ew WF item type 7. Defie required messages for the ew WF item type 8. Defie required otificatios for the ew item type 9. Defie a WF process diagram 10. Save the WF ito the database 11. Create the required PL/SQL Packages ad Procedures 12. Usig SDP, defie a Work Item which maps to the WF 13. Defie a service which maps to the Work Item defied i step List Timer APIs Process The followig provides a detailed descriptio of the steps defied i sectio Process Overview Implemetig Oracle Number Portability 82

97 Settig Profile Optios Usig imessage Studio 1. Logo to SDP 2. Access the imessage Studio scree from the Cofiguratio tab 3. Defie a Activity Timer Specify a Iteral Name Select Timer from the Type LOV Specify a Display Name Specify a Descriptio Select a value from the Priority LOV Select Timer Queue from the Queue Name LOV Specify a Resposibility 4. Click the Data Source tab 5. Defie the Delay ad Iterval for the Activity Timer Select the tree root for the Activity Timer (ie. I the figure above, ACTIVITY_TIMER_1 is selected). Select SQL Query from the Data Source Type LOV Select Oe ad Oly Oe from the Data Source Cardiality LOV Specify the Source for the Activity Timer IMPORTANT: The source SQL structure for the Activity Timer eeds to be of the followig format: SELECT D delay, I iterval FROM dual Where: D is the delay iteger value (secods) I is the iterval iteger value (secods) Select the DELAY brach from tree root for the Activity Timer (ie. I the figure below, DELAY is selected). Implemetig Oracle Number Portability 83

98 Settig Profile Optios Specify a Referece for the DELAY brach IMPORTANT: The Referece value DELAY brach eeds to map to the select-list specified i step 4 above. The Referece value eeds to be of the followig format: xp$<activity_timer_ame>.<select-list colum ame> Where: <acitivity_timer_ame> is the Iteral Name defied i step 3 above <select-list colum ame> is 1 st select-list value of the SQL source specified i step 4 above I the figure above, the Referece value for the DELAY brach is xp$activity_timer_1.delay Select the INTERVAL brach from tree root for the Activity Timer (ie. I the figure below, INTERVAL is selected). Specify a Referece for the INTERVAL brach IMPORTANT: The Referece value INTERVAL brach eeds to map to the select-list specified i step 4 above. The Referece value eeds to be of the followig format: xp$<activity_timer_ame>.<select-list colum ame> Where: <acitivity_timer_ame> is the Iteral Name defied i step 3 above <select-list colum ame> is 2 d select-list value of the SQL source specified i step 4 above I the figure above, the Referece value for the INTERVAL brach is xp$activity_timer_1.iterval 6. Click the Detail tab 7. Compile the Activity Timer Implemetig Oracle Number Portability 84

99 Settig Profile Optios 8. Click the Compile butto If all goes well you should be preseted with the above figure. 9. Click the View butto 10. Clickig the View butto eables to you to examie the PL/SQL package that is geerated as a result of compilig the Activity Timer. 11. Click the Close butto 12. Click the Apply butto 13. Defie a Process Timer Specify a Iteral Name Select Timer from the Type LOV Specify a Display Name Specify a Descriptio Select a value from the Priority LOV Select Timer Queue from the Queue Name LOV Specify a Resposibility 14. Click the Data Source tab 15. Defie the Delay ad Iterval for the Process Timer Select the tree root for the Process Timer (ie. I the figure above, PROCESS_ TIMER_1 is selected). Select SQL Query from the Data Source Type LOV Select Oe ad Oly Oe from the Data Source Cardiality LOV Specify the Source for the Process Timer IMPORTANT: The source SQL structure for the Activity Timer eeds to be of the followig format> Implemetig Oracle Number Portability 85

100 Settig Profile Optios SELECT D delay, I iterval FROM dual Where: D is the delay iteger value (secods) I is the iterval iteger value (secods) Select the DELAY brach from tree root for the Process Timer (ie. I the figure below, DELAY is selected). Specify a Referece for the DELAY brach IMPORTANT: The Referece value DELAY brach eeds to map to the select-list. The Referece value eeds to be of the followig format: xp$<process_timer_ame>.<select-list colum ame> Where: <process_timer_ame> is the Iteral Name defied i step 6 above <select-list colum ame> is 1 st select-list value of the SQL source specified i step 7 above I the figure above, the Referece value for the DELAY brach is xp$process_timer_1.delay Select the INTERVAL brach from tree root for the Process Timer (ie. I the figure below, INTERVAL is selected). Specify a Referece for the INTERVAL brach IMPORTANT: The Referece value INTERVAL brach eeds to map to the select-list specified i step 7 above. The Referece value eeds to be of the followig format: xp$<process_timer_ame>.<select-list colum ame> Implemetig Oracle Number Portability 86

101 Settig Profile Optios Where: <process_timer_ame> is the Iteral Name defied i step 6 above <select-list colum ame> is 2 d select-list value of the SQL source specified i step 7 above I the figure above, the Referece value for the INTERVAL brach is xp$process_timer_1.iterval 16. Click the Detail tab 17. Compile the Process Timer 18. Click the Compile butto If all goes well you should be preseted with the above figure. If a error is ecoutered, please check that you have followed steps 1-4 above correctly. 19. Click the OK butto 20. Click the Apply butto 21. Defie a Message Timer Specify a Iteral Name Select Message from the Type LOV Specify a Display Name 22. Specify a Descriptio Select a value from the Priority LOV Select Outboud Message Queue from the Queue Name LOV 23. Click the Apply butto 24. Defie a Evet for Message Ackowledgmet ad Timer Specify a Iteral Name Select Evet from the Type LOV Specify a Display Name Specify a Descriptio Select a value from the Priority LOV Select Iteral Evet Queue from the Queue Name LOV Implemetig Oracle Number Portability 87

102 Settig Profile Optios 25. Click the Apply butto 26. Defie Evet Subscriber which is associated with a Timer 27. Access the Evet Subscriber scree from the Cofiguratio tab Select the evet defied i step 9 above 28. Click the Timers tab Select the Activity Timer defied i step 3 above from the Timer LOV 29. Click the Apply butto 30. Defie Evet (Groupig of Message Ackowledgmet ad Timer) 31. Access the Evet Subscriber scree from the Cofiguratio tab Select the evet defied i step 10 above 32. Click the Resposes tab Select ACK from the Evet Code LOV Select timer defied i step 3 above from the Evet Code LOV 33. Click the Apply butto Geerate The Required Lookups Represetig The Timers Ivoke the load_sdp_lookups.sh script o the server. The sytax for ivokig this script is: load_sdp_lookups.sh <USERNAME> <PASSWORD> <WF USERNAME> <WF PASSWORD> <DB CONNECT STRING> Note: The SDP template ca be foud i the followig directory $SDP_TOP/xp/bi Implemetig Oracle Number Portability 88

103 Settig Profile Optios Usig Workflow to Build Timers 1. Start the Oracle Workflow Builder 2. Ope the SDP template XNPWFSTD.wft Note: The SDP template ca be foud i the followig directory $SDP_TOP/admi/import 3. Select the followig pre-defied SDP item types which are associated with the XNPWFSTD.wft template: SDP Lookup Codes SDP Stadard Stadard 4. Save the WF data store to a ew file. This prevets overwritig the SDP template XNPWFSTD.wft 5. Defie a New Item Type 6. Press OK Specify a Iteral Name Specify a Display Name Specify a Descriptio 7. Create 3 attributes for the Item Type you created i step 5 above Use the followig table as a guidelie for attribute details Iteral Name Display Name Descriptio Type ORDER_ID SDP Order ID SDP Order ID NUMBER LINE_ITEM_ID SDP Lie Item ID SDP Lie Item ID NUMBER WORKITEM_INSTACE_ID SDP Work Item Istace ID SDP work Item Istace ID NUMBER Implemetig Oracle Number Portability 89

104 Settig Profile Optios 8. Press OK IMPORTANT: DP requires that the above three (3) attributes be defied for each WF process. SDP will ot fuctio correctly without these attributes. 9. Defie ay other attributes that maybe required for the WF 10. Defie ay fuctios that maybe required for the WF. Specify a Iteral Name Specify a Display Name Specify a Descriptio Specify a Fuctio. Note that the fuctio must be of the followig format <package_ame>.<procedure_ame> 11. Press OK 12. Defie ay messages that maybe required for the WF otificatios Specify a Iteral Name Specify a Display Name Specify a Descriptio If this message is to be used with a otificatio that requires a respose the you eed to specify details i the Result tab. Specify a Display Name Specify a Descriptio Specify a Lookup Type Specify the Default Value type for the Message Result Implemetig Oracle Number Portability 90

105 Settig Profile Optios 13. Click OK IMPORTANT: If you make referece to ay TOKEN substitutios withi the message body, you eed to defie message attributes for each TOKEN specified i the message body. 14. Defie ay otificatios that maybe required for the WF Specify a Iteral Name Specify a Display Name Specify a Descriptio Specify a result type if a respose to the otificatio is required. IMPORTANT: If the message to be attached to this otificatio is expectig a respose from the otificatio, the you eed to specify a Result Type that is the SAME as the Lookup Type specified i the message Result tab. (see step 9 above). 15. Click OK Specify a message 16. Defie a process Specify a Iteral Name Specify a Display Name Specify a Descriptio 17. Click the Details Tab Specify The Error Process as XDP_ERROR_PROCESS. The XDP_ERROR_ PROCESS is optioal. You ca defied your ow error process. Implemetig Oracle Number Portability 91

106 Settig Profile Optios 18. Costruct the WF process diagram Double-Click the process defied i step 11 above Drag the START ad END fuctios from the Stadard Item Type ito the diagram Drag the required fuctios ad otificatios defied i steps 8 ad 10 above Drag the followig fuctios from the SDP Stadard Item: Fuctio Name Fire Timer Start Related Timers Sed Message Subscribe To Ackowledgmets Complete Work Item ad Update Status Descriptio Fuctio to start a Timer which ca be a Process or Activity Level timer Fuctio to start a Timer which maybe a Activity Timer or a Timer associated with a Message Fuctio to sed a message which has a timer associated to it Fuctio to subscriber for possible results from the Sed Message Fuctio Maages the SDP order status IMPORTANT: SDP requires that the Complete Work Item ad Update Status fuctio from the SDP Stadard Item Type be icluded i all WF process diagrams that are to be executed by SDP. SDP will ot fuctio correctly if this fuctio is omitted from the WF process diagram. Implemetig Oracle Number Portability 92

107 Settig Profile Optios 19. Create the trasitios betwee each activity i the WF process diagram IMPORTANT: SDP requires that the Complete Work Item ad Update Status fuctio be the last activity prior to the END fuctio i the WF process diagram. SDP will ot fuctio correctly uless the Complete Work Item ad Update Status is defied this way. Please ote the picture above. The fuctios are mapped to the Complete Work Item ad Update Status fuctio ad the Complete Work Item ad Update Status fuctio is mapped to the END fuctio. 20. Defie the fuctio properties for the Process Level Timer (ie. 1 st Fire Timer fuctio) Set the Node Attributes for the 1 st Fire Timer Activity to the followig Node Attribute Timer Name Callback Referece ID Custom Callback Referece ID Value Process Level Timer defie i step 6 above CUSTOM Workitem Istace ID 21. Defie the fuctio properties for the Activity Level Timer (ie. 2 d Fire Timer fuctio) Set the Node Attributes for the 2 d Fire Timer Activity to the followig Node Attribute Timer Name Callback Referece ID Custom Callback Referece ID Value Activity Level Timer defie i step 3 above CUSTOM Workitem Istace ID Implemetig Oracle Number Portability 93

108 Settig Profile Optios 22. Defie the Sed Message fuctio properties Set the Node Attributes for the Sed Message fuctio to the followig Node Attribute Evet Type Parameter List Receiver Name Adapter Name Callback Referece ID Custom Callback Referece ID Value Timer Message defied i step 9 above Dummy - Not to be used Dummy - Not to be used CUSTOM Workitem Istace ID 23. Defie the Start Related Timers fuctio properties Set the Node Attributes for the Start Related Timers fuctio to the followig Node Attribute Message Code Callback Referece ID Custom Callback Referece ID Value Timer Message defied i step 9 above CUSTOMER Workitem Istace ID 24. Defie the Subscribe to Ackowledgmets fuctio properties Set the Node Attributes for the Subscribe to Ackowledgmets fuctio to the followig Node Attribute Value Evet Type Evet Ackowledgmet defied i step 10 above Callback Referece ID Custom Callback Referece ID CUSTOMER Workitem Istace ID Implemetig Oracle Number Portability 94

109 Settig Profile Optios 25. Save your work to a file 26. Save you work to the database usig the WF schema user 27. Exit from the Oracle Workflow Builder Develop PL/SQL for Workflow Fuctios 1. Ope your favorite PL/SQL editor 2. Create the relevat packages ad procedures for each fuctio defied i sectio Usig Oracle Workflow Builder, step 8 3. Use the followig template as a guidelie for developig your PL/SQL procedure for use by WF <procedure_ame> (itemtypein VARCHAR2,itemkeyIN VARCHAR2,actidIN NUMBER,fucmodeIN VARCHAR2,resultoutOUT VARHCAR2) IS <local declaratios > IF (fucmode = RUN ) THEN <your RUN executable statemets> resultout := COMPLETE:<result> ; RETURN; ELSIF END IF; EXCEPTION WHEN OTHERS THEN WF_CORE.CONTEXT( <package_ame>, <procedure_ame>,<itemtype>,<itemkey>,<to_char(actid)>,<fucmode>); END; 4. Compile the packages/procedures i the XDP schema 5. Grat execute privileges o each package/procedure to the Workflow user 6. Coect to the Workflow schema as the Workflow user Create a syoym each package defied Implemetig Oracle Number Portability 95

110 Settig Profile Optios Timer Elemets A timer cosists of several madatory elemets, alog with as may additioal optioal elemets as ecessary to perform the busiess process. The table below lists these elemets ad describes them. Timer Elemets Elemet Madatory Descriptio Message type yes Type is timer. Timer ame yes The display ame for the timer. Timer iterval yes The period of time that the timer is active before it expires. Timer delay yes The amout of time to wait before startig the timig period.(the default is zero.)... o Other elemets as eeded. These elemets ca be related to a product type, customer category, or Service Level Agreemet accordig to the busiess requiremets of the users. Note: All timer delays ad itervals use secods as the uit of measure. Message Respose Timers versus Widow Timers The Service Delivery Platform uses two types of timers. They are: Message respose timers Widow timers Note: Service Delivery Platform timers use the Oracle Advaced Queue to perform queue operatios. See the Oracle Advaced Queue documetatio set for more iformatio. Implemetig Oracle Number Portability 96

111 Settig Profile Optios The followig table describes each of the two types. Service Delivery Platform Timer Types Type Message respose timers Widow timers Descriptio These timers are used to respod to messages geerated (typically) by workflow activity. The timer iterval is used to determie the time allowed to receive a respose for the message. These timers refer to a specific, well-defied period (or widow) of time. For example, you ca create a timer to sigal the occurrece of some future date mius 24 hours (ed date - 24). This is useful if you eed to determie whether or ot certai evets have occurred prior to this time so that the applicatio ca cotiue with its busiess processes. I this case, the delay would be: delay = (ed-date - 24) - curret_time Timers ad Jeopardy Maagemet After a timer expires, the message to which it is liked becomes visible i the Oracle Advaced Queue, ad the message is published to its subscribers. This message ca be used for a umber of purposes, icludig the followig: To otify the appropriate persoel to take ay ecessary actio to resolve the jeopardy coditio To iitiate actio withi a workflow to maage the situatio These kids of jeopardy maagemet procedures are cofigurable by the user. Implemetig Oracle Number Portability 97

112 Settig Profile Optios Jeopardy Notificatios i Service Delivery Platform Implemetig Oracle Number Portability 98

113 Settig Profile Optios Jeopardy Notificatios Jeopardy otificatios provide messages to Service Delivery Platform users if either of the followig occurs: A trasactio becomes overdue A trasactio may miss its assiged completio date Order Level Jeopardy Notificatios Service Delivery Platform provides a seeded default timer that you ca use to geerate Order level jeopardy otificatios. This timer is kow as the Default Jeopardy Timer. You may use either of the followig methods to calculate the timer iterval: The iterval for the timer is calculated based o the Order Due Date (the iteral date that stipulates the order completio date). This is the Service Delivery Platform default. Alteratively, you may retrieve the timer iterval through a stored procedure. Service Delivery Platform provides a stubbed stored procedure for this purpose. If you provide the stored procedure, the stubbed procedure ca be exteded or used to call the user-defied stored procedure. I this case, use the JTF user hooks framework to eable this fuctioality. For 11i, it should be possible to have a Order level jeopardy otificatio. A seeded default timer will be provided to eable this fuctioality. By default, the iterval for the timer will be calculated based o the Order Due Date. This is the iteral date to idicate the order completio date. The user ca alteratively use a customized jeopardy timer. If (Jeopardy Flag == Y ) //This call to the seeded timer may be replaced by the customized timer Seeded_Jeopardy_Timer.Fire(x_error_code); WHEN Due_Date_Not_Foud_Error; RAISE_APPLICATION_ERROR(-#,<Textual descriptio for Due Date Not Foud>); //Associate exceptio with # Implemetig Oracle Number Portability 99

114 Settig Profile Optios The Seeded Jeopardy Timer ivokes a fuctio to obtai the iterval for the timer based o the Due Date for the order. If (Due_Date NOT FOUND) RAISE Due_Date_Not_Foud_Error; //This exceptio trickles up Else Iterval = (Order Due Date - Sysdate)*24*60*60; This code may be placed i the Post sectio of the Process Order API. The post sectio of the API is completely customizable by the user. The default processig logic for the Seeded Jeopardy Timer will be used to ivoke a Jeopardy Timer Notificatio workflow process that will otify the FMC. A workflow process will be created to hadle this. The user will have the optio of firig the Jeopardy timer for each order by passig a Y or y value to the Jeopardy Eabled Flag i the XDP_OE_ORDER_HEADERS. The Isert_OE_Order API will check for the value of the Jeopardy Eabled flag. If the value of the flag is Y or y, the the jeopardy timer will be triggered. The jeopardy timer eeds to be removed as soo as the order is completed. The Remove_Timer API will be called to accomplish this. The order_id ad default jeopardy timer ame will be passed to the Remove Timer API call. The default processig logic for the jeopardy timer will sed a otificatio to FMC to idicate that a jeopardy timer for a particular order id has expired. Workflow otificatio will be used to pass the default message to FMC. There are o jeopardy maagemet processes associated with this timeout otificatio i SDP. However, users may cofigure customized jeopardy maagemet processes based o the jeopardy timeout fuctioality. Forms Impact: XDPORD.fmb. Add a Jeopardy Flag idicator to the form. Workflow: A default Jeopardy Timer Notificatio process will be created. This will be ivoked from the default processig logic of the seeded Default_Jeopardy_ Timer. A ew activity is created to check for the jeopardy flag related to the order id. If the jeopardy flag is Y, the the default jeopardy timer is ivoked. The DeRegister activity is ivoked i the post order sectio to deregister all timers for the give order id. The Customizable Oracle Provisioig Processes Pre Order ad Post Order are customized to icorporate this fuctioality. Implemetig Oracle Number Portability 100

115 Settig Profile Optios Implemetig Oracle Number Portability 101

116 Settig Profile Optios Seeded Pre-Order SDP Customizatio Seeded Post-Order SDP Customizatio Implemetig Oracle Number Portability 102

117 Settig Profile Optios Cofigurig a Jeopardy Timer The followig steps describe the process of activatig a jeopardy timer that is associated with a particular order: 1. You toggle the Jeopardy Eabled Flag i the XDP_OE_Order_Headers by passig it a Y or y value. 2. The Isert_OE_Order API checks for the value of the Jeopardy Eabled flag. If the value of the flag is Y or y, the the jeopardy timer is triggered. 3. Upo expiratio of the jeopardy timer, the default processig logic for the timer seds a otificatio to the Notificatios utility to idicate that a jeopardy timer for a particular order ID has expired. (Workflow otificatios are used to pass the default message to Notificatios module.) 4. You remove the jeopardy timer by callig the Remove_Timer API as soo as the order completes. I the call, you must pass the Order_ID ad the ame of the jeopardy timer to be removed. The followig diagram illustrates the process of cofigurig a jeopardy otificatio timer i Service Delivery Platform. Workflow Customizatios: The user of the applicatio is resposible for cofigurig this fuctioality. Pre Order Processig - Check if Jeopardy Idicator is Y (use the Get Jeopardy Flag activity). Fire default jeopardy timer if the idicator is Y. Post Order Processig - DeRegister timers usig Order_id The pre or post sectio of the Process Order public API withi SDP may be used to start the jeopardy timer(seeded or user-defied). Defiig the Message Data Source To set the source for the iformatio i a message, perform the followig steps. Note: Message elemets that are ot parameters require a data source. Prerequisites You must create the message details first, before you ca defie the message source. See Creatig a New Message for details. Implemetig Oracle Number Portability 103

118 Settig Profile Optios Defiig Your Ow Message Processig Logic Icomig messages ad evets are hadled by the Evet Maager. There are multiple ways i which a message ca be processed. To defie the message processig logic, perform the followig steps. Prerequisites You must create the message details first, before you ca defie the message processig logic. See Creatig a New Message for details. Guidelies The followig table lists the four types of message processig logic ad provides a brief descriptio of each. Type Default Process Logic Validate Logic Icomig Message Process Logic Outgoig Message Process Logic Descriptio If o applicatio has registered for the message, the Evet Maager automatically executes the default processig logic DEFAULT_PROCESS() for that message. The VALIDATE() procedure provides a hook to iclude busiess specific validatio. It is automatically executed by the Evet Mager o the ewly arrived message. The PROCESS() procedure also provides a hook to iclude the applicatio logic. It is executed by the Evet Mager before deliverig the message to the callback procedure of the registered applicatio. The outgoig process logic is executed before the message is put o the Outgoig Queue for delivery. The user-defied code is executed as part of the SEND() procedure. Implemetig Oracle Number Portability 104

119 Settig Profile Optios Compilig imessages Perform the followig steps to compile a message. You ca also select Setup > Message Defiitio > Compile imessage to compile a sigle message, or Setup > Message Defiitio > Compile All imessages to perform a batch compile. Warig: Always esure that o dequeuers or adapters are ruig whe compilig messages i productio. Prerequisites The message must exist before you ca compile it. Sedig a Test Message You test how a message fuctios i Service Delivery Platform usig the imessage Studio Test Message iterface. You use this utility to test sedig a message to a queue. The message ca also be tested usig the stadard SQL*PLUS iterface. You may use the Order Flowthrough utility, or the Workflow Moitor to moitor the progress of the message. Errors durig processig appear i the Notificatios utility. Use this iformatio to correct the error, the resubmit it to the queue for processig, if ecessary. Note: The Test Message iterface ca be accessed either from the imessage Studio or from the Test Ceter meu. To test a message, perform the followig steps. Prerequisites You must first compile the message before you ca test it. Implemetig Oracle Number Portability 105

120 Settig Profile Optios Steps 1. I the Navigator, choose Setup > Message Defiitio > imessage Studio. 2. Select the Test Message tab. 3. Select the message code from the list at the left for the message you wish to test. The Parameter ad Data Type fields fill i automatically. 4. Eter a value i the Referece Id field. This referece value relates the message beig set or received with the curret applicatio trasactio. For example, this value could be the Order ID. 5. Eter a value i the Opposite Referece Id field. This referece value relates the message beig set or received with the remote applicatio trasactio. For example, this value could be the workflow istace. 6. Eter a (comma-separated) list of fulfillmet elemet ames i the Cosumer List field to which the message or evet will be set (published). 7. Eter the Service Provider Code of the curret service provider i the Seder Name field. For example, this value could be Eter the Service Provider Code of the iteded recipiet service provider i the Recipiet List field. For example, this value could be This field may be left empty for evets that are beig published. 9. Eter the versio umber of the message beig set. This value is icremeted oly if the origial message caot be processed due to some error. 10. Click Sed to sed the test message. 11. Click OK to exit. A cofirmatio widow opes cotaiig the Message ID ad similar iformatio. It is suggested that you maually record this data as it is useful i trackig a message withi the system. Implemetig Oracle Number Portability 106

121 Settig Profile Optios Workig with Evet ad Timers You perform a umber of tasks relatig to evets ad timers. These iclude the followig: Creatig a ew evet Creatig a ew timer Associatig a evet with a subscriber Creatig a New Evet To create a ew evet message, perform the followig steps. Prerequisites Noe Steps 1. I the Navigator, choose Setup > Message Defiitio > imessage Studio. 2. Click the New ico o the toolbar to create a ew evet message. 3. Select the Details tab. 4. Select Evet from the drop-dow list of available types. 5. Eter a short ame for the evet i the Display Name field. This ame is refereced by the message studio whe geeratig procedures. 6. Eter a brief descriptio of the evet. 7. Select a priority for the evet. This value sets the priority for the evet message i the outboud or iboud message queue. 8. Select a queue ame from the drop-dow list. Select either: Iboud Message Queue Outboud Message Queue If you are ucertai of which of these two to chose, the keep the default value uchaged. Implemetig Oracle Number Portability 107

122 Settig Profile Optios 9. Chose a user Resposibility for this message from the drop-dow list. 10. Eter the DTD Locatio path. This value sets the path structure to the file that holds all the schema (Documet Type Defiitios) for this message. The file is amed <message>.dtd, where <message> correspods to the ame of the message you are curretly defiig. 11. Close the widow. You are prompted to save your chages. Creatig a New Timer All timers must have a delay ad a iterval defied as elemets. These two elemets, Delay ad Iterval, ca be oe of the followig: These elemets ca be default values. These values ca be retrieved from a message store usig a user-defied procedure. Warig: Delay ad Iterval ca ot be parameters. Prerequisites Noe Steps 1. I the Navigator, choose Setup > Message Defiitio > imessage Studio. 2. Click the New ico o the toolbar to create a ew timer message. 3. Select the Details tab. 4. Select Timer from the drop-dow list of available types. 5. Eter a short ame for the evet i the Display Name field. This ame is refereced by the imessage Studio whe geeratig procedures. 6. Eter a brief descriptio of the timer. 7. Select a priority for the timer. This value sets the priority for the timer message i the Timer Message Queue. Implemetig Oracle Number Portability 108

123 Settig Profile Optios 8. Select Timer Message Queue from the drop-dow list. 9. Chose a user resposibility for this message from the Resposibility drop-dow list. 10. Eter the DTD Locatio path. This value sets the path structure to the file that holds all the schema (Documet Type Defiitios) for this message. The file is amed <message>.dtd, where <message> correspods to the ame of the message you are curretly defiig. 11. Close the widow. You are prompted to save your chages. Note: You ca ot add ew elemets to a timer. Associatig a Respose with a Evet You ca associate oe or more resposes with each defied evet. These resposes are used by the applicatio workflow i the performace of activities. Note: If a message has a associated timer, the timer must be cofigured as a respose for the evet. Prerequisites You must first defie a evet before you ca associate a respose with it. Steps 1. I the Navigator, choose Setup > Message Defiitio > imessage Subscribers. 2. Select the Resposes tab. 3. Select a evet from the Evets pae at the left-had side of the widow. 4. Chose a Evet Code from the drop-dow list. Note that it is possible to lik multiple evets to the selected evet, if desired. 5. Close the widow. You are prompted to save your chages. Implemetig Oracle Number Portability 109

124 Settig Profile Optios Evet for Timer or Message Ackowledgemet The Waitig For Ackowledgemets activity subscribes to evets. A evet may be cofigured to iclude ad Ackowledgemet for the Message set out ad a Timer. Depedig o the message received, the workflow progresses. For example., We may have a evet group call MSG_ACK_TIMER_1 that cosists of Timer 1 ad Ack. Depedig o Timer 1 or Ack beig received, the workflow progresses. Registerig Default Message Subscribers To register message subscribers to receive automatic otificatio whe a evet occurs, perform the followig steps. Prerequisites Noe Steps 1. I the Navigator, choose Setup > Message Defiitio > imessage Subscribers. 2. Select the Default Subscribers tab. 3. Select a evet from the list at the left. 4. Chose a fulfillmet elemet to associate with the evet, usig the drop-dow list. 5. Add additioal fulfillmet elemets, if desired, i the spaces provided. 6. Repeat steps 3 through 5, as may times as ecessary. 7. Close the widow. You are prompted to save your chages. Note: You ca also register message subscribers by registerig a API usig the Callback Registratio widow. Implemetig Oracle Number Portability 110

125 System Profile Optios System Profile Optios The followig are System Profile optios for Oracle Number Portability : Note: To set profile optios, you must be logged i as System Admiistrator, ot NP System Admiistrator. The table followig lists the profile optios that you ca set i the applicatio. Service Delivery Platform Profile Optios Profile Optio Name ACK_REQD_FLAG DEFAULT_PORTING_STATUS ENABLE_FEATURES ENABLE_NRC INSTALL_MODE MAX_RETRIES POP_TIMEOUT SHOW_PROTECTED_MSG SP_NAME TIMER_ACK_TIMEOUT_DURATION Descriptio Esures guarateed delivery of messages. Adapters will sed ACK back to callig program. The default is N. Iitial portig status that is assiged to a portig record. Determie if features such as CNAM, LIDB are available for Istallatio Determies if this istallatio requires use of a cetral referece database. Istallatio mode for operatio of Number Portability The maximum umber of attempts that Sed Message makes. Sed Message Pop Time-out Determies whether imessage Studio Form displays seed messages Service Provider Code for Service Bureau mode. Defies the Time-out duratio while waitig for a Ackowledgmet messages from the Remote System. Duratio is i secods. Implemetig Oracle Number Portability 111

126 System Profile Optios The AOL Geeric Loader The Oracle Applicatio Object Library loader is a geeral purpose data migratio tool that is used for patchig seed data, deliverig traslatios, or copyig setup or trasactio data from developmet to productio systems. The loader is a cocurret program amed FNDLOAD. To use this utility, eter the followig commad at a UNIX prompt. FNDLOAD apps/pwd 0 Y mode cofigfile datafile etity [ param... ] The table followig lists the parameters used with this executable ad describes them. FNDLOAD Parameter List Parameter apps/pwd Descriptio Specifies the APPS schema ad password. If the coect_strig is omitted, it is take i a platform-specific maer from the eviromet usig the ame TWO_TASK 0 Y Cocurret program flags mode Specifies either UPLOAD or DOWNLOAD operatio. UPLOAD causes the specified data file to be uploaded to the database. DOWNLOAD causes the loader to fetch rows ad write them to the specified data file. cofigfile Specifies the cofiguratio file to use. The cofiguratio file usually eds with a suffix of.lct, but this rule is either eforced or supplied by the loader. datafile etity param Specifies the data file to write. (DOWNLOAD) If the data file already exists, the it is overwritte. The cofiguratio file usually eds with a suffix of.lct, but this rule is either eforced or supplied by the loader. Specifies the etity type to begi the dowload or upload. If you wish to upload all of the etity types i a data file (.ldt), specify a dash (-) as the etity type. Specifies zero or more additioal parameters that are used to provide bid values i the access SQL (for both the UPLOAD ad DOWNLOAD operatios). Each parameter is of the form NAME=VALUE. The give NAME must ot coflict with a attribute ame for the etities beig loaded. Implemetig Oracle Number Portability 112

127 System Profile Optios Loader File Defiitios You ca fid the FNDLOAD cofiguratio files for XNP at the followig locatio: $XNP_TOP/patch/115/import/*.lct The table followig lists the Loader files used with Oracle Number Portability ad provides the etities ad dowload parameters supported by each. See the cotets of the idividual cofiguratio file for full documetatio o usage. Loader File Descriptio (Optioal Dowload Parameters) Name Descriptio Etity Parameters xpcbevt.lct Callback Evets XNP_CALLBACK_EVENTS MSG_CODE xpevtsb.lct Evet Subscribers XNP_EVENT\_SUBSCRIBERS MSG_CODE FE_NAME xpgeoas.lct Geographic Areas ad Hierarchy XNP_GEO_AREAS XNP_GEO_HIERARCHY CODE CODE xpmsgak.lct Message Ackowledgmets XNP_MSG_ACKS MST_CODE xpmsgps.lct Messages XNP_MSG_TYPES MSG_CODE xpsumr.lct Served Number Rages XNP_SERVED_NUM_RANGES STARTING_ NUMBER FE_NAME FEATURE_TYPE xpsptre.lct Service Providers XNP_SERVICE_PROVIDERS CODE xpstats.lct Portig Status Types XNP_SV_STATUS_TYPES STATUS_TYPE_CODE xptmrpb.lct Timer Publishers XNP_TIMER_PUBLISHERS MSG_CODE Implemetig Oracle Number Portability 113

128 System Profile Optios The followig tables lists depedecies betwee the various files. Loader File Depedecies Name xpcbevt.lct xpevtsb.lct xpgeoas.lct xpmsgak.lct xpsumr.lct xptmrpb.lct Depedecy First ru xpmsgps.lct First load the fulfillmet elemet data First load the Areas, the the Hierarchy First ru xpmsgps.lct First load the fulfillmet elemet data, the ru xpsptre.lct First ru xpmsgps.lct Refereces For additioal iformatio, see the files i the followig applicatio directories. Template cofiguratio file /fddev/fd/11.5/admi/import/fdstd.lct Existig AOL cofiguratio files /fddev/fd/11.5/admi/import/*.lct Trasferrig Lookups to Workflow To trasfer commo lookup codes from the cofiguratio tables to workflow, perform the followig steps. Prerequisites Noe Steps 1. I the Navigator, choose Setup > Applicatio Defiitio > Trasfer Lookups to Workflow. The Load NP ad OP Lookups oto Workflow widow opes with the correct default values already set. 2. Click Submit to accept the defaults ad start the trasfer process. 3. Close this widow whe the process is complete. Implemetig Oracle Number Portability 114

129 System Profile Optios Dowloadig Portig Lookups to File To write the portig lookup codes from workflow ito a ASCII file, perform the followig steps. Prerequisites You must first trasfer the lookups to workflow. See Trasferrig Lookups to Workflow for details. Steps 1. I the Navigator, choose Setup > Applicatio Defiitio > Dowload Portig Lookups to File. The Dowload NP Lookups from Workflow widow opes with the correct default values already set. 2. Click Submit to accept the defaults ad start the dowload process. This actio retrieves the NP lookup codes from the database ad stores them i file XNPDNPLK.wft. 3. Close this widow whe the process is complete. Note: To access the output files geerated by the Lookup dowload, refer to the Oracle Applicatios 11i System Admiistrator s Guide, "Accessig Cocurret Maager Output ad Log Files." Dowloadig Commo Lookups to File To write the commo lookup codes from workflow ito a ASCII file, perform the followig steps. Prerequisites You must first trasfer the lookups to workflow. See Trasferrig Lookups to Workflow for details. Implemetig Oracle Number Portability 115

130 System Profile Optios Steps 1. I the Navigator, choose Setup > Applicatio Defiitio > Dowload Commo Lookups to File. The Dowload OP Lookups from Workflow widow opes with the correct default values already set. 2. Click Submit to accept the defaults ad start the dowload process. This actio retrieves the Service Delivery Platform lookup codes from the database ad stores them i file XNPDOPLK.wft ad XNPDNPLK.wft. The lookup codes i the geerated files cotai the Service Delivery Platform cofiguratio iformatio, icludig message defiitios, fulfillmet actios, ad similar iformatio. You ca use this iformatio for buildig your busiess processes. 3. Close this widow whe the process is complete. Note: To access the output files geerated by the Lookup dowload, refer to the Oracle Applicatios 11i System Admiistrator s Guide, "Accessig Cocurret Maager Output ad Log Files." Creatig a Custom Notificatio Message Perform the steps followig to defie a customized otificatio message that ca be displayed at rutime. Prerequisites Noe Implemetig Oracle Number Portability 116

131 System Profile Optios Steps 1. Create a ASCII text file as a cotaier for the desired message. 2. Name the file with the followig format: X%_NOTFN_% Do ot exceed 29 characters total for the legth of the file ame. 3. Eter the text of your message. For example, this could be similar to the followig message: Portig requested for &STARTING_NUMBER through &ENDING_NUMBER o &NEW_SP_DUE_DATE. The tokes after the ampersad (&) character are ames of work item parameters. At rutime, the otificatios utility scas the message ad replaces the tokes with the values of the work item parameters. 4. Ru the lookup loader script to load these user defied messages oto the workflow lookup code CUSTOMIZED_NOTN_MESSAGES. The message utility sets the first lie of the otificatio message to item attribute MSG_SUBJECT, ad the etire cotets of the file to item attribute MSG_BODY. The created otificatio cotais the message with all the refereced work item parameters replaced with the actual value. Message Processig Logic i Oracle Number Portability Icomig messages ad evets are hadled by the Evet Maager i Oracle Number Portability. There are four possible ways that a message ca be processed by the applicatio. They are: Default process logic Validate logic Icomig Message process logic Outgoig Message process logic Implemetig Oracle Number Portability 117

132 System Profile Optios Followig is a brief descriptio of each type. Note: If the user does ot provide ay message processig logic, the default is a NULL package body. Default Process Logic If o applicatio has registered for the message, the Evet Maager automatically executes the default processig logic DEFAULT_PROCESS() for that message. The followig example shows how to provide a applicatio hook usig the DEFAULT_PROCESS() procedure. Cosider a case i which a PORTING_CONCUR message comes i asychroously. The default processig logic for this message is: DECLARE l_telephoe_um VARCHAR2(10) ; l_clli VARCHAR2(20) ; l_area_code VARCHAR2(3) ; BEGIN /* Reset error code ad error message */ x_error_code := 0 ; x_error_message := NULL ; /* Retrieve the Telephoe umber message elemet from the XML message */ XNP_XML_UTILS.DECODE( p_msg_text, TELEPHONEí, l_ telephoe_um) ; /* Retrieve the cetral office or the CLLI o which it has to be provisioed */ XNP_XML_UTILS.DECODE( p_msg_text, CLLI, l_ clli) ; Implemetig Oracle Number Portability 118

133 System Profile Optios /* Esure that the right cetral office is used for provisioig */ l_area_code := SUBSTR(l_telephoe_um,1,3 ) ; IF ((l_area_code = ë415í) AND (l_clli = ësfoí)) THEN /* Customized procedure to provisio the umber */ /* Not part of NP core fuctios */ ELSE /* Customized procedure to otify the customer care system. Not part of NP core fuctios */ NOTIFY_CUSTOMER_CARE(l_t, error_code, error_message) ; END IF ; END ; x_ x_ Implemetig Oracle Number Portability 119

134 System Profile Optios Validate Logic The VALIDATE() procedure provides a hook to iclude busiess specific validatio ad is automatically executed by the Evet Maager o ewly arrived messages. If o validatio logic is specified, the procedure is created with a "NULL;" statemet. The sigature for this procedure is give i the followig code. Note: The Evet Maager will ot process ad deliver the message i case a error is retured i X_ERROR_CODE or X_ ERROR_MESSAGE. However the resultig error code ad error message is logged ito the system log messages. VALIDATE( p_msg_header IN XNP_MESSAGE.MSG_HEADER_REC_TYPE, p_msg_text IN VARCHAR2, x_error_code OUT NUMBER, x_error_message OUT VARCHAR2, p_process_referece IN VARCHAR2 DEFAULT NULL ) ; The followig is a example of code that checks for a valid telephoe umber. (The use of XNP_XML_UTILS.DECODE works oly i case of messages with o repeatig elemets.) DECLARE l_telephoe_um VARCHAR2(10) ; l_service_provider VARCHAR2(10) ; BEGIN /* Reset error code ad error message */ x_error_code := 0 ; x_error_message := NULL ; /* Retrieve the telephoe umber */ XNP_XML_UTILS.DECODE( p_msg_text, TELEPHONE, Implemetig Oracle Number Portability 120

135 System Profile Optios telephoe_um ) ; l_ /* Retrieve the service provider */ XNP_XML_UTILS.DECODE( p_msg_text, SERVICE_PROVIDER, service_provider ) ; /* Ccustom procedure to check if the telephoe umber is i the service providerís defied umber rage */ TN_RANGE.CHECK_SP_VALIDITY( l_telephoe_um, l_service_provider, x_error_code, x_error_message ) ; END ; Icomig Message Process Logic The PROCESS() procedure also provides a hook to iclude the applicatio logic ad is executed by the Evet maager before deliverig the message to the callback procedure of the registered applicatio. The followig example code stores the PORTING_ID from a NPR_ACK for the recipiet. DECLARE l_reference_id VARCHAR2(40) := NULL; l_portig_id VARCHAR2(40); BEGIN x_error_code := 0; /* * Get the OPP_REFERENCE_ID as i the received message * which is the workitem istace id. */ XNP_XML_UTILS.DECODE l_ Implemetig Oracle Number Portability 121

136 System Profile Optios (p_msg_text, OPP_REFERENCE_ID, l_reference_id ) ; -- Get the NPR PORTING_ID XNP_XML_UTILS.DECODE (p_msg_text, PORTING_ID, l_portig_id ) ; XDP_ENGINE.SET_WORKITEM_PARAM_VALUE (to_umber(l_reference_id), PORTING_ID,l_portig_id,NULL ); /* Set the referece to commuicate with Number Registratio Ceter, is the PORTING_ID */ XDP_ENGINE.SET_WORKITEM_PARAM_VALUE (to_umber(l_reference_id), OPP_REFERENCE_ID,l_portig_id,NULL ); END; Outgoig Message Process Logic The out process logic is executed before equeueig the message for delivery No procedure is geerated but the defied code is executed as part of the SEND() procedure Loggig a out goig message ca be a good use of this hook The followig example code copies a message from the outboud to the iboud queue. BEGIN DECLARE my_header XNP_MESSAGE.MSG_HEADER_REC_TYPE ; my_xml VARCHAR2(4000); BEGIN my_header := l_msg_header ; Implemetig Oracle Number Portability 122

137 System Profile Optios my_xml := l_msg_text ; XNP_MESSAGE.GET_SEQUENCE(my_header.message_id) ; my_header.directio_idr := I ; XNP_MESSAGE.PUSH(p_msg_header=>my_header, p_body_text => my_xml, p_queue_ame=>xnp_event.c_inbound_msg_q, p_correlatio_id=> MSG_SERVER ) ; END; END; Workflows Workflows i Oracle Number Portability are sub-processes which execute durig the order fulfillmet process. Workflows are used to automate the busiess processes ecessary to fulfill the order. Workflows are geerally referred to as work items i the applicatio. Workflows are created usig the Oracle Workflow Builder. Oracle Workflow Builder You use the Oracle Workflow Builder to customize your busiess eeds. Through workflow, you ca route ay type of iformatio i a asychroous maer, accordig to your busiess rules. Withi the Oracle Workflow Builder, you create, view, or modify a busiess process with simple drag ad drop operatios. I additio, you ca create ad modify all workflow objects, icludig activities, item types, processes ad otificatios. At ay time, you ca perform the followig operatios o workflow objects: Add Remove Modify Set up ew prerequisite relatioships amog the various types You ca easily work with a summary-level model of your workflow, expadig activities withi the workflow as eeded to greater levels of detail. Implemetig Oracle Number Portability 123

138 System Profile Optios Referece See Appedix B: Sample Workflows See the Oracle Workflow documetatio set for iformatio relatig to the use of workflow. Workflow Activity Fuctios Whe defiig a workflow, it is importat to uderstad the iteractio betwee Oracle Workflow ad Oracle Number Portability. I simple terms, you build your workflow usig ay or all of the followig types of fuctio activities: Stadard fuctio activities provided by Oracle Workflow Stadard fuctio activities provided by Service Delivery Platform Stadard fuctio activities provided by Oracle Number Portability Your ow user-defied fuctio activities Stadard Fuctio Activities Provided by Oracle Workflow These types of fuctio activities are actios that simply progress a workflow to the ext activity, or chage stadard workflow iformatio. For example, this could be merely the start or the ed of a workflow. These fuctios are defied durig workflow istallatio, i the Stadards sectio. These procedures types are held i the WF_STANDARD package i ay Oracle database. Do ot adjust these procedures. Implemetig Oracle Number Portability 124

139 System Profile Optios Stadard Fuctio Activities Provided by the Service Delivery Platform Fuctio activities i workflow are split ito those activities specific oly to the Service Delivery Platform, ad those activities specific oly to umber portig. Fuctio activities that are specific to the Service Delivery Platform are geerally related to messagig, timers, sychroizatio, preparig otificatios, work items, ad fulfillmet actios. Fuctio activities that are specific to umber portig are related to the umber portability process. This allows for a better visual uderstadig of the differece betwee the activities. Certai actios that take place i a process require a check with, or a update to, the Service Delivery Platform cofiguratio. Several examples: If a activity i a workflow is to chage the portig status of a order, a umber of checks eed to be made agaist the data held i Service Delivery Platform. I particular, the applicatio must verify that the ew portig status is a valid oe. Durig Sed Message a check must be made with the applicatio s repository to esure that the message is a valid message ad that the parameters are correct. The actual PL/SQL procedures for fuctios that are specific to Service Delivery Platform ad Oracle Number Portability are held i the XNP_WF_STANDARD package. Implemetig Oracle Number Portability 125

140 System Profile Optios The table followig lists the Service Delivery Platform stadard fuctio activities supplied with the applicatio. Service Delivery Platform Stadard Fuctio Activities Name Descriptio Check Order Result Determies the value of the of the ORDER_RESULT work item parameter, ad completes the activity based o this value. Complete Work Items ad Update Status Execute Fulfillmet Actio Prepare Customized Notificatio Prepare Notificatio Message Publish Evet Sed Message Set Order Result Subscribe to Ackowledgmets Subscribe to Busiess Evet Sets the work item status, ad otifies the order trackig system (the Service Delivery platform), about the completio of the work item. Executes the fulfillmet actio for the give feature type. It associates the fulfillmet elemet to a work item, ad submits it for provisioig. It the registers for a evet to wake it up after the fulfillmet actio is complete. Defies a customized otificatio to be displayed at rutime. Prepares the otificatio to be set to the target. Publishes a sigle busiess evet. I the case of iteral evets, ay recipiets of this evet must already have subscribed to the evet. Seds a message to a sigle recipiet. The Sed procedure first checks whether or ot a adapter is available for the recipiet of the message. If a adapter is available, it proceeds with the sed actio. If a adapter is uavailable, a callback is registered to receive a otificatio oce the adapter becomes available. Sets the value of the ORDER_RESULT work item parameter to the lookup value set by the workflow builder. Idetifies ad registers for all expected resposes messages. (I may cases, sedig a request message ca result i the geeratio of multiple respose messages.) Registers a callback for the give evet from the remote or local system. Implemetig Oracle Number Portability 126

141 System Profile Optios Stadard Fuctio Activities Provided by Oracle Number Portability The table followig lists the Number Portability stadard fuctio activities supplied with the applicatio. Number Portability Stadard Fuctio Activities Name Descriptio Check if Door Ca Port Out Checks whether or ot the door service provider of this portig trasactio has provisioed the umber rage, or has assiged the umber rage. If either coditio is true, the the activity completes with Y. Check if Door is Iitial Door Also Checks whether or ot this door is also the iitial door. Create Portig Order Creates a Portig Record for each telephoe umber i the rage. The Portig ID for the first record is the same as that set i the work item parameter. Create SMS Portig Records Creates a Portig Record for each telephoe umber i the rage. The Portig ID for the first record is the same as that set i the work item parameter. Deprovisio FEs Sets the fulfillmet elemets to be deprovisioed for this feature type ad umber rage. For each fulfillmet elemet, the Service Delivery Platforms s provisioig procedure (Execute FA) is ivoked. At the ed of this activity, cotrol passes to the provisioig subsystem which executes the fulfillmet procedure. A FA_DONE message is subscribed for each fulfillmet actio beig executed which gives the executio result of the fulfillmet procedure. The callback procedure associated with the FA_DONE hadles the resposes received. The immediate ext activity followig this activity must be the SDP Stadard Wait For Flow. This is to esure proper had-off from the provisioig system back to the Number Portability system. Oly fulfillmet elemets that were earlier provisioed by this service provider ca be modified. Otherwise, the fulfillmet elemets are igored. Determie Curret Service Provider Role Determie If Subsequet Portig Request Does Portig Record Exist for Door Determies whether or ot a give service provider is the door, origial door or recipiet for the curret portig trasactio ad completes the activity with the appropriate result code. Checks whether or ot this is a subsequet portig request. Returs either Y or N. Check whether or ot there exists a portig record with the give status i this telephoe umber rage that belogs to the give door s service provider ID. Returs either Y or N. Implemetig Oracle Number Portability 127

142 System Profile Optios Number Portability Stadard Fuctio Activities Name Descriptio Does Portig Record Exist for Recipiet Get Flag Value Get Portig Status Modify FEs Provisio FEs Reject Message Remove from SMS Provisioig Map Retry Message Check whether or ot there exists a portig record with the give status i this telephoe umber rage that belogs to the give recipiet s service provider ID. Returs either Y or N. Retrieves the Locked flag value for the give PORTING_ID work item parameter. The activity completes with a flag value of Y or N. Retrieves the status of the portig record for the give Portig ID Retrieves the fulfillmet elemets to be modified for this feature type ad umber rage. For each fulfillmet elemet, the Service Delivery Platform s provisioig procedure (Execute FA) is ivoked. At the ed of this activity, cotrol passes to the provisioig subsystem which executes the fulfillmet procedure. A FA_DONE message is subscribed for each fulfillmet actio beig executed which gives the executio result of the fulfillmet procedure. The callback procedure associated with the FA_DONE hadles the resposes received. The immediate ext activity followig the activity must be SDP Stadard Wait For Flow. This is to esure proper had-off from the provisioig system back to the Number Portability system. Oly fulfillmet elemets that were earlier provisioed by this service provider ca be modified. Otherwise, the fulfillmet elemets are igored. Sets the fulfillmet elemets to be provisioed for this feature type ad umber rage. For each fulfillmet elemet, the Service Delivery Platform s provisioig procedure (Execute FA) is ivoked. At the ed of this activity the cotrol passes to the provisioig subsystem which executes the fulfillmet procedure. A FA_DONE message is subscribed for each fulfillmet actio beig executed which gives the executio result of the fulfillmet procedure. The callback procedure associated with the FA_DONE hadles the resposes received. The immediate ext activity followig this activity must be the SDP Stadard Wait For Flow. This is to esure proper had-off from the provisioig system back to the Number Portability system. Rejects a message. Deletes the fulfillmet elemet mappig for this telephoe umber rage from the applicatio database. Retries the message. Implemetig Oracle Number Portability 128

143 System Profile Optios Number Portability Stadard Fuctio Activities Name Descriptio Set Flag Value Update Chargig Iformatio Update Commets ad Notes Iformatio Update Curret SV Status Update Customer Iformatio Update Network Iformatio i SOA Update Portig Status Update SMS Provisioig Map Update with New Date Verify Portig Status Sets the flag to the give value for the etities i XNP_SV_SOA for the give PORTING_ID work item parameter ad FLAG_NAME for the curret service provider. Sets a values of Y or N. Updates the Subscriptio Versio i the Service Order Admiistrator for each telephoe umber with the give Portig ID with the ivoice iformatio. Updates the commets ad otes for the curret Portig ID ad the curret service provider. Updates the status type code i the XNP_SV_SOA with the ew status type code. All records with the Portig ID ad belogig to the curret service provider are updated to the ew status. If the ew status belogs to the ACTIVE phase, ad if there exists records for this umber rage already i ACTIVE phase, the these records are first reset to the OLD phase. The actual update of the records with the give portig ID is performed after this step. Updates the customer iformatio for the curret Portig ID ad the curret service provider. Updates the etwork iformatio i the XNP_SV_SOA for the curret Portig ID ad the curret service provider. Updates the status type code i the XNP_SV_SOA with the ew status type code. All records with the portig ID ad belogig to the curret service provider are updated to the ew status. If the ew status belogs to the ACTIVE phase, ad if there exists records for this umber rage already i ACTIVE phase, the these records are first reset to the OLD phase. The actual update of the records with the give portig ID is performed after this step. Updates the Provisioig Status of the fulfillmet elemet for the give feature type ad telephoe umber rage. Updates the date for the portig record with the give Portig ID. The format used must be i the followig format: YYYY/MM/DD HH24:MI:SS Checks if the STATUS_TYPE_CODE from XNP_SV_SOA for the give PORTING_ID is same as the give status type code (i STATUS_TO_ COMPARE_WITH). Returs T if the two statuses match. Returs F if the two statuses do ot match. Implemetig Oracle Number Portability 129

144 System Profile Optios User-defied Fuctio Activities Some actios that take place i a process are user specific actios. These actios may, or may ot, have stadard workflow or Oracle Number Portability implicatios. For example, it is possible that a umber i a log table must be icremeted every time a status chage has occurred. As this activity is ot a order specific actio, this is merely a example of a procedure that retrieves the umber from the table ad adds oe to it. I cotrast, a user-defied procedure cotais some workflow or Oracle Number Portability API calls i it. For example, returig to the previous log table example, it is possible that there is a requiremet to log the From Status ad the To Status whe a order status chage takes place. I order to perform this actio, a user-defied procedure must first retrieve the order parameters or the work item parameters usig a Oracle Number Portability API call, ad the isert them ito the log table. Aother example of a user-defied procedure that is refereced by a workflow fuctio is the process of retrievig the Existig Service Provider Name parameter from the Oracle Number Portability order ad the usig the retrieved value to determie the service provider idetifier. The procedure code ca the update the work item parameter SP_ID i the Oracle Number Portability order. Implemetig Oracle Number Portability 130

145 Cosideratios for Future Upgrade Cosideratios for Future Upgrade The followig are cosideratios for future System-Level upgrades: System Profiles Eabled Workflows Employees ad Security Multicurrecy capabilities Customizatio Issues Implemetig Oracle Number Portability 131

146 Implemetig Oracle Number Portability 132

147 A Public APIs Public APIs A-1

148 A-2 Product Title/BookTitle as a Variable

149 PROCEDURE Process_Order Specificatio API Name: Process_Order Type: Public Purpose: This API is used for submittig a service order to SDP. Pre-Requisites: Noe. Parameters: IN : p_api_versio: NUMBER Required p_iit_msg_list: VARCHAR2 Optioal Default = FND_API.G_FALSE p_commit: VARCHAR2 Optioal Default = FND_API.G_FALSE Whe callig this API via a database lik, this parameter must be FND_API.G_FALSE p_validatio_level NUMBER Optioal Default = FND_API.G_VALID_LEVEL_FULL p_order_header: XDP_TYPES.ORDER_HEADER Required Order header iformatio which requires the followig atrribute values to be supplied: order_umber: The order idetifier which is assiged by the callig system order_versio: The versio of the order. This attribute ca be NULL provisioig_date: Public APIs A-3

150 to begi ot supplied the sysdate. (Cotiued o ext page) The date this order is supposed provisioig. If the value is it will be default to the (Cotiued from previous page) ca be applied This attribute is jeopardy aalysis or ot. The user with other order user hook package jeopardy timer or optioal. LIST order_actio: The provisioig actio which to all the lies i the order. optioal. jeopardy_eabled_flag: The flag idicates whether the should be eabled for the order ca the use this flag combie iformatio i the post process to determie whether to start a ot. This attribute is p_order_parameter: XDP_TYPES.ORDER_PARAMETER_ (Cotiued o ext page) (Cotiued from previous page) Required all Required requires supplied: The parameters that ca be accessed by the order lies. The list ca be empty. p_order_lie_list: XDP_TYPES.ORDER_LINE_LIST The list of order lie items which the followig attribute values to be A-4 Product Title/BookTitle as a Variable

151 lie. If this it to the order supplied SDP will depedecy betwee supplied SDP will lie. (Cotiued o ext page) (Cotiued from previous page) LIST Required order lie. The list list, the supplied: associated with ull. lie_umber: The idex umber of the curret lie lie_item_ame: The ame of the service item versio: The versio of the service item actio: The provisioig actio of the curret value is ot supplied, SDP will default actio provisioig_date: The date this order lie is scheduled to be provisioig. If the value is ot default it to order provisioig date. provisioig_sequece: SDP uses this attribute to determie order lies. If the value is ot assume there is ot depedecy for this p_lie_parameter_list: XDP_TYPES.LINE_PARAM_ The list of the parameters for each ca be empty. For every record i the followig attribute values to be lie_umber: The lie umber of this parameter is parameter_ame: The ame of the parameter parameter_value: The value of the parameter. It ca be parameter_ref_value: The referece value of the parameter. Public APIs A-5

152 This attribute is optioal. value value is routie routie OUT : x_retur_status: VARCHAR2(1) Required The caller must examie this parameter after the call is completed. If the FND_API.G_RET_STS_SUCCESS, the caller must do commit, otherwise, the caller must do rollback. x_msg_cout: NUMBER x_msg_data: VARCHAR2(2000) x_sdp_order_id: NUMBER The iteral order ID which is assiged by SDP whe a order is successfully submitted to SDP Versio: Curret versio 11.5 Notes: This API is used for upstream orderig system to submit a service order to SDP. If the customer wishes to perform order depedecy ad jeopardy aalysis, he or she ca put the busiess logic i the post process API uder the customer hook package which will be supported by SDP per CRM codig stadard. A-6 Product Title/BookTitle as a Variable

153 PROCEDURE Process_Order( FULL, p_api_versio IN NUMBER, p_iit_msg_list IN VARCHAR2 := FND_API.G_FALSE, p_commit IN VARCHAR2 := FND_API.G_FALSE, p_validatio_level IN NUMBER := FND_API.G_VALID_LEVEL_ x_return_status x_msg_cout x_msg_data P_ORDER_HEADER P_ORDER_PARAMETER P_ORDER_LINE_LIST P_LINE_PARAMETER_LIST x_sdp_order_id OUT VARCHAR2, OUT NUMBER, OUT VARCHAR2, IN XDP_TYPES.ORDER_HEADER, IN XDP_TYPES.ORDER_PARAMETER_LIST, IN XDP_TYPES.ORDER_LINE_LIST, IN XDP_TYPES.LINE_PARAM_LIST, OUT NUMBER); Public APIs A-7

154 PROCEDURE Cacel_Order Specificatio API Name: Cacel_Order Type: Public Purpose: This API is used for cacelig a service order Pre-Requisites: Noe. A-8 Product Title/BookTitle as a Variable

155 Parameters: IN : p_api_versio: NUMBER Required p_iit_msg_list: VARCHAR2 Optioal Default = FND_API.G_FALSE p_commit: VARCHAR2 Optioal Default = FND_API.G_FALSE This API is a autoomous routie which hadles the database trasactio idepedetly. The value of p_commit parameter will be igored. p_validatio_level NUMBER Optioal Default = FND_API.G_VALID_LEVEL_FULL p_sdp_order_id: NUMBER Required The iteral order ID which was assiged by SDP whe a order was successfully submitted to SDP p_caller_ame: VARCHAR2 Required The ame of the user who is callig this API OUT : x_retur_status: VARCHAR2(1) Required The executio status of the API call. x_msg_cout: NUMBER x_msg_data: VARCHAR2(2000) Versio: Curret versio 11.5 Notes: This API is used for upstream orderig system to cacel a service order which was submitted to SDP previously. Public APIs A-9

156 PROCEDURE Cacel_Order( FULL, p_api_versio IN NUMBER, p_iit_msg_list IN VARCHAR2 := FND_API.G_FALSE, p_commit IN VARCHAR2 := FND_API.G_FALSE, p_validatio_level IN NUMBER := FND_API.G_VALID_LEVEL_ x_return_status OUT VARCHAR2, x_msg_cout OUT NUMBER, x_msg_data OUT VARCHAR2, P_SDP_ORDER_ID IN NUMBER, p_caller_ame IN VARCHAR2 ); A-10 Product Title/BookTitle as a Variable

157 PROCEDURE Process_DRC_Order Specificatio REM Process_DRC_Order REM Public REM API for processig a DRC order i a sychroous mode REM Noe. REM REM IN : p_api_versio IN NUMBER Required REM p_iit_msg_list IN VARCHAR2 Optioal REM Default = FND_API.G_FALSE REM p_commit IN VARCHAR2 Optioal REM Default = FND_API.G_FALSE REM p_validatio_level IN NUMBER Optioal REM Default = FND_API.G_VALID_LEVEL_FULL REM P_WORKITEM_ID IN NUMBER Required The iteral ID of the work item to be executed REM P_TASK_PARAMETER IN XDP_TYPES.ORDER_ PARAMETER_LIST The list of parameters for the request API Name: Cacel_Order Type: Public Purpose: This API is used for cacelig a service order Pre-Requisites: Noe. Public APIs A-11

158 Parameters: OUT : x_retur_status OUT VARCHAR2(1) The executio status of the API call. x_msg_cout OUT NUMBER x_msg_data OUT VARCHAR2(2000) x_sdp_order_id OUT NUMBER The iteral order ID which is assiged by SDP whe the request is fulfilled Versio: Curret versio 11.5 Notes: This API is used for the test ceter to execute a work item sychroously. The process flow is as followed: 1. Check if the work item ca be executed sychroously. The coditio is that the FA mappig type of the work item must be either STATIC or DYNAMIC. This API does ot ivoke ay workflow. It does ot use ay OP process queue either. 2. Create a dummy service order i SDP for trackig purpose oly. The iteral order ID will be retured to the caller after the call is completed. 3. Fid out all the FAs which have bee mapped to this work item per cofiguratio. 4. For each FA, fid out which FE it will be executed upo. 5. Fid the available adapter for the give FE. The usage code for the adapter must be TEST. 6. Execute the appropriate Fulfillmet Procedure. 7. Retur whe all the FAs have bee executed. A-12 Product Title/BookTitle as a Variable

159 PROCEDURE Process_DRC_Order( FULL, p_api_versio IN NUMBER, p_iit_msg_list IN VARCHAR2 := FND_API.G_FALSE, p_commit IN VARCHAR2 := FND_API.G_FALSE, p_validatio_level IN NUMBER := FND_API.G_VALID_LEVEL_ x_return_status x_msg_cout x_msg_data P_WORKITEM_ID P_TASK_PARAMETER x_sdp_order_id OUT VARCHAR2, OUT NUMBER, OUT VARCHAR2, IN NUMBER, IN XDP_TYPES.ORDER_PARAMETER_LIST, OUT NUMBER); Public APIs A-13

160 A-14 Product Title/BookTitle as a Variable

161 B Sample Workflows Sample Workflows B-1

162 B-2 Product Title/BookTitle as a Variable

163 B.0.1 Iquire Recipiet Operator For Portig I S top FA Processig Complete Work Item ad Update S tatus Retry FA Processig Cotiue FA Processig Notify User of Error Complete Work Item ad Update S tatus Ed (Failure) Prepare Notificatio Mess age Missig or Icorrect Data <Default> S uccess Portig Iquiry Respose Yes Start Validate Portig Iquiry Parameters (ST UB Subprocess) Sed Message Subscribe to Ackowledgemets Check Order R esult Prepare Notificatio Message Display Portig Iquiry Respose Failure <T imeout> No Prepare Notificatio Message Prepare Notificatio Mess age Prepare Notificatio Message Or Display Portig Iquiry Respose Complete Work Item ad Update S tatus Ed (S uccess) Retry FA Processig Validatio Failed Notificatio <Default> Complete Work Item ad Update S tatus Ed (Failure) No Repose from Exteral SystemFYI Complete Work Item ad Update S tatus Ed (Failure) Iteral Name: PORTING_INQUIRY_FROM_OMS Descriptio: New Operator receives portig iquiry from Order Maagemet System. A portig iquiry is lauched ad a respose is obtaied from the Door operator ad the respose is coveyed to the Order Maagemet System. Sample Workflows B-3

164 B.0.2 Portig Order Iitiated By Recipiet Operator Iteral Name: PORTING_ORDER_FROM_OMS Descriptio: Recipiet Operator receives portig order from Customer Care or a Order Etry System. A Portig Subscriptio Versio is created ad the Portig Order Iquiry is set to the NRC. The process the waits for a approval or rejectio from the NRC. B-4 Product Title/BookTitle as a Variable

165 B.0.3 Iquire Recipiet Operator For Portig I : StopFAProcessig CompleteWork Item adupdatestatus RetryFAProcessig CotiueFAProcessig NotifyUser of Error CompleteWork Item adupdatestatus Ed(Failure) PrepareNotificatio Message <Default> <Default> Missigor Icorrect Data <Default> Yes UpdatePortig Status SedMessage <Timeout> PortigCreate/ModifyOrder Complete Subscribeto Subscribeto Ackowledgemets Busiess Evets CompleteWork Item adupdatestatus Ed(Success) Start RetryFAProcessig Success ValidatePortig CreatePortigOrder Order Request Parameters (STUB Subprocess) Failure PrepareNotificatio Message ValidatioFailed Notificatio <Default> SedMessage PortigOrder Respose Subscribeto Check Order Result Ackowledgemets <Timeout> PrepareNotificatio Message NoReposefrom Exteral SystemFYI CompleteWork Item adupdatestatus RetryFAProcessig Ed(Failure) No UpdatePortig Status PrepareNotificatio Message NotifyUser of Error StopFAProcessig Missigor Icorrect Data StopFAProcessig RetryFAProcessig NotifyUser of Error CompleteWork Item adupdatestatus PrepareNotificatio Message CotiueFAProcessig CompleteWork Item adupdatestatus CompleteWork Item adupdatestatus Ed(Failure) CotiueFAProcessig CompleteWork Item adupdatestatus Ed(Failure) CompleteWork Item adupdatestatus Ed(Failure) Iteral Name: PORTING_INQUIRY_FROM_OMS Descriptio: New Operator receives portig iquiry from Order Maagemet System. A portig iquiry is lauched ad a respose is obtaied from the Door operator ad the respose is coveyed to the Order Maagemet System. Sample Workflows B-5

166 B.0.4 Respod To Portig Order Received By Door Operator Complete Work Item adupdate Status Ed(Failure) Door <Default> Create Portig Order <Default> Start Success Validate Portig Determie Service Order Request Provider Role Parameters (ST UB Subprocess) Origial Door Create Portig Order Failure SedMessage Determie If Subsequet Portig Request Yes Determie if Subsequet Portig is Possible (Subprocess) No No Yes Determie if Portig Update Portig Set Order Result is Possible Status (Subprocess) No <Default> Notify User of Error Complete Work Item adupdate Status Update Portig Status Prepare Notificatio Message Retry FAProcessig Ed(Failure) Success Portig Create/Modify Order Complete Process Portig Subscribe to Order (Subprocess) Busiess Evets Complete Work Item Ed(Success) adupdate Status Error Complete Work Item Ed(Failure) adupdate Status Yes Missig or Icorrect Data Set Order Result <Default> <Default> <Default> Complete Work Item adupdate Status Origial Door Determie Service Update Portig Provider Role Status Set Order Result Portig Create/Modify Order Complete <T imeout> SedMessage Subscribe to Subscribe to Ackowledgemets Busiess Evets <Default> Complete Work Item adupdate Status Ed(Success) Ed(Failure) Notify User of Error Prepare Notificatio Message Update Portig Status Retry FAProcessig <Default> No Door SedMessage Portig Order Respose Subscribe to Check Order Result Ackowledgemets Yes Update Portig Status <T imeout> Prepare Notificatio Message No Repose from ExteralSystemFYI Iteral Name: PORTING_ORDER_FROM_OPERATOR Descriptio: A portig Order Request is received from the Recipiet operator ad the required validatios are performed to determie a cocurrece or rejectio. A cocurrece or portig rejectio reply is set back to the Recipiet operator. B-6 Product Title/BookTitle as a Variable

167 B.0.5 Charge New Operator For Portig Request Iteral Name: REC_RECEIVE_CHARGING_NOTIF Descriptio: Door Operator charges recipiet operator for the port-out trasactio. The cost of the Port Out trasactio is added to the ivoice of the Recipiet operator ad the ivoice is set to the Recipiet operator. Sample Workflows B-7

168 B.0.6 Portig Notificatio Cocurrece <Default> <Default> Start Validate Portig Notificatio Cocurrece (STUB Subprocess) S uccess Update Portig Status Determie Service Provider Role Recipiet Sed Message Subscribe to Ackowledgemets Missig or Icorrect Data <T imeout> Failure Retry FA Processig Prepare Notificatio Message Stop FA Processig Sed Message Notify User of Error Cotiue FA Processig Complete Work Item ad Update S tatus Ed (Failure) Complete Work Item ad Update S tatus Ed (Failure) Or Complete Work Item ad Update S tatus Ed (S uccess) Cotiue FA Processig Complete Work Item ad Update S tatus Retry FA Processig Notify User of Error Stop FA Processig Prepare Notificatio Message Ed (Failure) Missig or Icorrect Data <Default> Door <T imeout> Sed Message Subscribe to Ackowledgemets Iteral Name: RECEIVE_CONCURRENCE Descriptio: Door Operator ad Recipiet Operator receive cocurrece otificatio from NRC for a portig trasactio. The Subscriptio Versio status is updated ad the operators wait for a etwork update otificatio from the NRC. B-8 Product Title/BookTitle as a Variable

169 B.0.7 Reject Portig Request S ucces s Start Validate P ortig N otificatio Rejectio P arameters (S T U B S ubproces s ) Update Portig Status P repare Notificatio P ortig N otificatio Message Rejectio Message Complete W ork Item ad U pdate S tatus Ed (Success) F ailure S ed Mes sage Complete W ork Item ad U pdate S tatus Ed (Failure) Iteral Name: PORTING_NOTIFICATION_REJECTION Descriptio: Door Operator ad Recipiet Operator receive rejectio otificatio from NRC for a portig trasactio. The Subscriptio Versio status is updated ad a otificatio is set to the Customer Care System. Sample Workflows B-9

170 B.0.8 Remid Operator For Portig Respose Success Start ValidatePortig NotificatioRequest Parameters (STUB Subprocess) PrepareNotificatio Message PortigNotificatio Remider Message CompleteWork Item adupdatestatus Ed(Success) Failure SedMessage CompleteWork Item adupdatestatus Ed(Failure) Iteral Name: PORTING_NOTIFICATION_REMINDER Descriptio: A Portig Order Iquiry has bee set to the Door operator ad o respose has bee obtaied from the Door. The Recipiet or the NRC remids the Door operator of the impedig Portig request depedig o the implemetatio. It is assumed that the portig process is iitiated by the Recipiet operator. B-10 Product Title/BookTitle as a Variable

171 B.0.9 Create Or Modify Ported Number(s) Stop FA Processig Complete Work Item ad U pdate S tatus Retry FA Processig Cotiue FA Processig Notify User of Error Complete Work Item ad U pdate S tatus Ed (Failure) Prepare Notificatio Message Missig or Icorrect Data <Default> Sed Message Subscribe to Ackowledgemets <T imeout> Start Validate New Referece Data Notificatio Parameters (ST UB Subprocess) S uccess Create SMS Portig Records Provisio Network Elemets (Master S ubproces s ) Ad Update Portig Status Publish Message Failure Sed Message Complete Work Item ad U pdate S tatus Ed (Failure) Complete Work Item ad U pdate S tatus E d (S uccess) Iteral Name: PROVISION_PORTED_NUMBER Descriptio: Whe a etwork dowload arrives from the NRC, the Recipiet operator adds the ew subscriber to its etwork while the Door removes the subscriber from its etwork. Addig a subscriber may ivolve addig the telephoe umber ad ay of the features or services subscribed to. Sample Workflows B-11

172 B.0.10 Load, Disaster Recovery & Backup Of Local Database S top F A Process ig Complete Work Item ad Update S tatus Retry FA Processig Cotiue FA Processig Notify User of Error Complete Work Item ad Update S tatus Ed (Failure) Prepare Notificatio Mess age Missig or Icorrect Data <Default> Start S uccess Validate R eferece Data Backup Request Parameters (ST UB Subprocess) Failure Sed Message Subscribe to Ackowledgemets <T imeout> Referece Data Backup Respose Process Referece Data Backup Request Ack Complete Work Item ad U pdate S tatus Ed (S ucces s) Prepare Notificatio Mes sage Prepare Notificatio Mess age No Repose from Exteral System FYI Retry FA Processig Validatio Failed Notificatio <Default> Complete Work Item ad Update S tatus Ed (Failure) Iteral Name: LOAD_DISASTER_RECOVERY_BACKUP Descriptio: Sed a etwork dowload request to the NRC for sychroizig the local copy of the data with the NRC data ad update the local or referece database with data from the admiistratio database. B-12 Product Title/BookTitle as a Variable

173 B.0.11 Query Portig Data Stop FA Processig Complete Work Item ad Update S tatus Retry FA Processig Notify User of Error Cotiue FA Processig Complete Work Item ad Update S tatus Ed (Failure) Prepare Notificatio Message Missig or Icorrect Data <Default> Start Success Validate Referece Sed Message Data Cotrol Request Parameters (STUB Subprocess) Subscribe to Ackowledgemets <T imeout> Referece Data Cotrol Respose Prepare Notificatio Message Display Portig Referece Data Complete Work Item ad Update S tatus Ed (Success) Failure Prepare Notificatio Message Prepare Notificatio Message No Repose from Exteral SystemFYI Retry FA Processig Validatio Failed Notificatio <Default> Complete Work Item ad Update S tatus Ed (Failure) Iteral Name: QUERY_REFERENCE_DATA Descriptio: Sed a query to the NRC for portig data. This is required for comparig the portig data i the local database with the data i the NRC database. Such comparisos are called Audits. Sample Workflows B-13

174 B.0.12 Modify Portig Request From Order Etry Iteral Name: MODIFY_PORT_REQ_FROM_OMS Descriptio: A Portig Request is pedig ad the customer wats a modificatio to the request. Oe example of such modificatio is modifyig the portig due date. The Subscriptio Versio i the local database is modified ad a portig modificatio request is set to the NRC. It is up to the busiess process to allow or ot to allow such modificatios. A example is, allow ay modificatio prior to twety four hours of the activatio due date but o modificatios after that. B.0.13 Modify Portig Request From Operator Iteral Name: MODIFY_PORT_REQ_FROM_OPERATOR Descriptio: A modificatio request to the Subscriptio Versio arrives from the NRC or the other operator. Modificatios to the subscriptio versio is made ad a portig modificatio ackowledgmet is set back. B.0.14 Cacel Modify Portig Request From Order Etry Iteral Name: CANCEL_MODIFY_PORT_FROM_OMS Descriptio: A cacel request o a previous modify request arrives from the Order Etry System. The pedig modificatio request is deleted or the modificatio is rolled back. B-14 Product Title/BookTitle as a Variable

175 B.0.15 Hold Portig Request From Order Etry Iteral Name: HOLD_PORT_REQ_FROM_OMS Descriptio: Customer cotacts ew operator to place a portig request o hold. The status of the portig request is set to HOLD. B.0.16 Hold Portig Request From Other Operator Iteral Name: HOLD_PORT_REQ_FROM_OPERATOR Descriptio: A hold o the Portig Request is received from the NRC or the other operator. The status of the portig request is set to HOLD. B.0.17 Cacel Portig Request From Order Etry Iteral Name: CANCEL_PORT_REQ_FROM_OMS Descriptio: A cacel o the Portig request arrives from the Order Etry System. If a Subscriptio Versio is already created at the NRC, the cacel request will also be set to the NR. The status of the portig request is set to CANCELLED. Sample Workflows B-15

176 B.0.18 Discoect Portig Request From Order Etry Iteral Name: DISC_PORT_REQ_FROM_OMS Descriptio: A discoect request is received from the Order Etry System ad a provisioig order is iitiated to discoect the customer from the etwork. B.0.19 Cacel Discoect Portig Request From Order Etry Iteral Name: CANCEL_DISC_PORT_REQ_FROM_OMS Descriptio: A cacel o a previous discoect request is received from the Order Etry System. The impedig discoect request is deleted. B.0.20 Number Rage Split Request From Order Etry Iteral Name: NUMBER_RANGE_SPLIT Descriptio: Number Rage Split declared by a regulatory board. B.0.21 Trasfer Number Rage Holder From Order Etry Iteral Name: TRANSFER_NUMBER_RANGE_HOLDER Descriptio: Trasfer Number Rage Holder declared by a regulatory board. B-16 Product Title/BookTitle as a Variable

177 B.0.22 Delete Ported Number(s) Stop FA Processig Complete Work Item ad Update S tatus Retry FA Processig Cotiue FA Processig Notify User of Error Complete Work Item ad Update S tatus Ed (Failure) Prepare Notificatio Message Missig or Icorrect Data <Default> Success Sed Message Subscribe to Ackowledgemets <T imeout> Start Validate Referece Data Remove Notificatio Parameters (STUB Subprocess) Success Deprovisio Network Elemets (Master S ubprocess) Ad Update Portig Status Remove S MS Portig Records Publish Message Complete Work Item ad Update S tatus Ed (Success) Failure Sed Message Complete Work Item ad Update S tatus Ed (Failure) Iteral Name: DELETE_PORTED_NUMBERS. Descriptio: Remove portig data from etwork elemets provisioed earlier. This may be i respose to a broadcast received from NRC to carry out this activity. Sample Workflows B-17

178 B-18 Product Title/BookTitle as a Variable

179 C SDP Parameters SDP Parameters C-1

180 C-2 Product Title/BookTitle as a Variable

181 SDP Parameters These parameters are provided with the applicatios ad ca be utilized at order, lie item, work item, ad fulfillmet actio levels. New parameters ca be added to your cofiguratio. Proceeded parameters should ever be modified or deleted.r Iteral Name Display Name Descriptio MESSAGE_VERSION Message Versio Message Versio REFERENCE_ID Referece Id Referece Idetificatio OPP_REFERENCE_ID Opp Referece Id Opp Referece Idetificatio SUBSCRIPTION_TN Subscriptio TN Subscriptio Telephoe Number STARTING_NUMBER Startig Number Startig Number ENDING_NUMBER Edig Number Edig Number PORTING_ID Portig Id Portig Idetificatio NEW_SP_DUE_DATE New SP Due Date New Service Provider Due Date DONOR_SP_ID Door SP Id Door Service Provider Idetificatio RECIPIENT_SP_ID Recipiet SP Id Recipiet Service Provider Idetificatio ROUTING_NUMBER Routig Number Routig Number MESSAGE_ID Message Id Message Idetificatio CUSTOMER_ID Customer Id Customer Idetificatio CUSTOMER_NAME Customer Name Customer Name ADDRESS_LINE1 Address Lie1 Address Lie1 ADDRESS_LINE2 Address Lie2 Address Lie2 ZIP_CODE Zip Code Zip Code CITY City City PHONE Phoe Phoe FAX Tax Tax CONTACT_NAME Cotact Name Cotact Name CONTACT_DEPT Cotact Dept. Cotact Departmet SDP Parameters C-3

182 CUSTOMER_CONTACT_ REQ_FLAG Customer Cotact Req Flag Customer Cotact Required Flag OLD_SP_DUE_DATE Old SP Due Date Old Service Provider Due Date ORDER_RESULT Order Result Order Result ORDER_REJECT_CODE Order Reject Code Order Reject Code ORDER_REJECT_EXPLN Order Reject Explai Order Reject Explaatio OLD_SP_CUTOFF_DUE_ DATE RETAIN_TN_FLAG Old SP Cutoff Due Date Retai Subscriptio TN Flag RETAIN_DIR_INFO_FLAG Retai Dir Ifo Flag PRIORITY Priority Priority Old Service Provider Cutoff Due Date Retai Subscriptio Telephoe Number Flag Retai Directory Iformatio Flag GEO_AREA_CODE Geo Area Code Geographic Area Code PRICE_PER_MINUTE Price per Miute Price per Miute PRICE_PER_CALL Price per Call Price per Call PRICE_CODE Price Code Price Code SERVICE_INFO Service Ifo Service Iformatio INVOICE_DUE_DATE Ivoice Due Date Ivoice Due Date ORDER_PRIORITY Order Priority Order Priority CHARGING_INFO Chargig Ifo Chargig Iformatio SENDER_NAME Seder Name Seder Name RECIPIENT_NAME Recipiet Name Recipiet Name INITIAL_DONOR_SP_ID Iitial Door SP Id Iitial Door Service Provider Idetificatio CREATION_DATE Creatio Date Creatio Date ORDER_VERSION Order Versio Order Versio CLASS_ADDRESS CLASS Address CLASS Address CLASS_SUBSYSTEM CLASS Subsystem CLASS Subsystem CNAM_ADDRESS CNAM Address CNAM Address CNAM_SUBSYSTEM CNAM Subsystem CNAM Subsystem C-4 Product Title/BookTitle as a Variable

183 ISVM_ADDRESS ISVM Address ISVM Address ISVM_SUBSYSTEM ISVM Subsystem ISVM Subsystem LIDB_ADDRESS LIDB Address LIDB Address LIDB_SUBSYSTEM LIDB Subsystem LIDB Subsystem WSMSC_ADDRESS WSMSC Address WSMSC Address WSMSC_SUBSYSTEM WSMSC Subsystem WSMSC Subsystem RN_ADDRESS RN Address RN Address RN_SUBSYSTEM RN Subsystem RN Subsystem EXT_CLASS_ADDRESS Ext CLASS Address Exteral CLASS Address EXT_CLASS_SUBSYSTEM Ext CLASS Subsystem Exteral CLASS Subsystem EXT_ISVM_ADDRESS Ext ISVM Address Exteral ISVM Address EXT_ISVM_SUBSYSTEM Ext ISVM Subsystem Exteral ISVM Subsystem EXT_CNAM_ADDRESS Ext CNAM Address Exteral CNAM Address EXT_CNAM_SUBSYSTEM Ext CNAM Subsystem Exteral CNAM Subsystem EXT_LIDB_ADDRESS Ext LIDB Address Exteral LIDB Address EXT_LIDB_SUBSYSTEM Ext LIDB Subsystem Exteral LIDB Subsystem EXT_WSMSC_ADDRESS Ext WSMSC Address Exteral WSMSC Address EXT_WSMSC_ SUBSYSTEM Ext WSMSC Subsystem Exteral WSMSC Subsystem EXT_RN_ADDRESS Ext RN Address Exteral RN Address EXT_RN_SUBSYSTEM Ext RN Subsystem Exteral RN Subsystem ERROR_CODE Error Code Error Code ERROR_DESCRIPTION Error Descriptio Error Descriptio EXT_ROUTING_NUMBER Ext Routig Number Exteral Routig Number SP_ID SP Id Service Provider Idetificatio AUDIT_NAME Audit Name Audit Name SMS_FAILURE_DATE SMS Failure Date SMS Failure Date ADAPTER_NAME Adapter Name Adapter Name SDP Parameters C-5

184 GEO_AREA_TYPE_CODE Geo Area Type Code Geographic Area Type Code GEO_AREA_NAME Geo Area Name Geographic Area Name GEO_AREA_DISPLAY_ NAME Geo Area Display Name Geographic Area Display Name INTERCONNECT_TYPE Itercoect Type Itercoect Type FE_NAME FE Name Fulfillmet Elemet Name ORDER_ID Order Id Order Idetificatio MESSAGE_CODE Message Code Message Code ASSIGNED_SP_ID Assiged SP Id Assiged Service Provider Idetificatio OWNING_SP_ID Owig SP Id Owig Service Provider Idetificatio NUMBER_RANGE_CODE Number Rage Code Number Rage Code EFFECTIVE_DATE Effective Date Effective Date GEO_INDICATOR Geo Idicator Geographic Idicator MOBILE_INDICATOR Mobile Idicator Mobile Idicator POOLED_FLAG Pooled Flag Pooled Flag PORTED_INDICATOR Ported Idicator Set if the Number Rage is Ope to Portability SERVICE_TYPE Service Type Service Type STATUS Status Status PERMISSIVE_DIAL_ START_DATE PERMISSIVE_DIAL_END_ DATE OLD_NUMBER_RANGE_ CODE NEW_NUMBER_RANGE_ CODE CONVERSION_ PROCEDURE Permissive Dial Start Date Permissive Dial Ed Date Old Number Rage Code New Number Rage Code Coversio Procedure FEATURE_TYPE Feature Type Feature Type Start Date o which the old ad ew umber rage are both active. Ed Date after which the old umber rage is o loger active. Number rage prior to a umber rage split. New umber rage after a umber rage split. Procedure to covert a old umber to the ew umber whe it has bee affected by C-6 Product Title/BookTitle as a Variable

185 FE_ID FE Id Fulfillmet Elemet Idetificatio NUMBER_RANGE_ID Number Rage Id Number Rage Idetificatio PRIMARY_FLAG Primary Flag Primary Flag COUNTRY Coutry Coutry DEPARTMENT Departmet Departmet INTERNET_ADDRESS Iteret Address Iteret Address MOBILE Mobile Mobile SP_NAME SP Name Service Provider Name PAGER Pager Pager PAGER_PIN Pager Pi Pager Pi SERVED_BY_FLAG Served by Flag Served by Flag SP_TYPE SP Type Service Provider Type STATE State State TIMEZONE Timezoe Timezoe BUSINESS_ROLE Busiess Role Busiess Role ACTIVATION_START_ DATE ACTIVATION_END_ DATE Activatio Start Date Activatio Ed Date Portig activatio start date. Portig activatio complete date. AUDIT_TYPE Audit Type Audit Type CLASS_FLAG CLASS Flag CLASS Flag CNAM_FLAG CNAM Flag CNAM Flag FOR_SP_ID For SP Id For Service Provider Idetificatio ISVM_FLAG ISVM Flag ISVM Flag LIDB_FLAG LIDB Flag LIDB Flag RN_FLAG RN Flag RN Flag ROUTING_NUMBER_ FLAG Routig Number Flag Routig Number Flag WSMSC_FLAG WSMSC Flag WSMSC Flag TIMESTAMP Timestamp Timestamp SDP Parameters C-7

186 USERNAME Userame Userame NRC_NAME NRC Name NRC Name MEDIATOR_SP_ID Mediator SP Id Mediator Service Provider Idetificatio NRC_SV_ID NRC SV Id NRC Subscriptio Versio Idetificatio SUBSCRIPTION_TYPE Subscriptio Type Subscriptio Type SV_SMS_ID SV SMS Id Subsriptio Versio SMS Idetificatio SV_SOA_ID SV SOA Id Subscriptio Versio SOA Idetificatio ACTIVATION_DUE_ DATE Activatio Due Date Portig Activatio Due Date BILLING_ID Billig Id Billig Idetificatio BLOCKED_FLAG Blocked Flag Blocked Flag CHANGED_BY_SP_ID Chaged By SP Id Chaged by Service Provider Idetificatio CONCURRENCE_FLAG Cocurrece Flag Cocurrece Flag CREATED_BY_SP_ID Created By SP Id Created by service provider idetificatio CUSTOMER_TYPE Customer Type Customer Type DISCONNECT_DUE_ DATE Discoect Due Date Discoect Due Date EFFECTIVE_RELEASE_ DUE_DATE Effective Release Due Date LOCKED_FLAG Locked Flag Locked Flag NEW_SP_ AUTHORIZATION_FLAG OLD_SP_ AUTHORIZATION_FLAG New SP Authorizatio Flag Old SP Authorizatio Flag Effective Release Due Date PORTING_TIME Portig Time Portig Time NUMBER_RETURNED_ DUE_DATE Number Retured Due Date Set if Portig Request Authorized by New Service Provider Set if portig request authorized by old service provider. Number Retured Due Date C-8 Product Title/BookTitle as a Variable

187 PREORDER_ AUTHORIZATION_CODE PREV_STATUS_TYPE_ CODE PRE_SPLIT_ SUBSCRIPTION_TN Preorder Authorizatio Code Prev Status Type Code Pre-Split Subscriptio TN Preorder Authorizatio Code e.g. Letter of Agecy Previous Status Type Code Telephoe Number prior to a umber rage split. PTO_FLAG PTO Flag Port to Origial Flag STATUS_CHANGE_ CAUSE_CODE Status Chage Cause Code Status Chage Cause Code STATUS_TYPE_CODE Status Type Code Status Type Code USER_LOCTN_TYPE User Loct Type User Locatio Type USER_LOCTN_VALUE User Loct Value User Locatio Value NEW_STATUS_TYPE_ CODE OLD_STATUS_TYPE_ CODE New Status Type Code Old Status Type Code New Status Type Code Old Status Type Code ACTIVE_FLAG Active Flag Active Flag STATUS_NAME Status Name Status Name PHASE_INDICATOR Phase Idicator Phase Idicator DESCRIPTION Descriptio Descriptio DISPLAY_NAME Display Name Display Name LANGUAGE Laguage Laguage SOURCE_LANG Source Lag Source Laguage PRODUCT_TYPE_CODE Product Type Code Product Type Code TIMER_TYPE_CODE Timer Type Code Timer Type Code TIMER_VALUE Timer Value Timer Value UNIT_OF_MEASURE Uit of Measure Uit of Measure FAILURE_DATE Failure Date Failure Date SUBSEQUENT_PORT Subsequet Port Is this a subsequet port? SYNC_LABEL Syc Label Uique label used for sychroizatio SDP Parameters C-9

188 SYNC_REQD_FLAG Syc Required Flag Flag to idicate if sychroizatio was required across lie items RANGE_COUNT Rage Cout Cout of the umber of Number Rages which are beig ported together COMMENTS Commets User Commets NOTES Notes User Notes C-10 Product Title/BookTitle as a Variable

189 D Number Portability Views Number Portability Views D-1

190 D-2 Product Title/BookTitle as a Variable

191 You ca use these views to select MLS compliat iformatio from the Number Portability Repository. Selectig data directly from tables is ot supported as more etities may be made MLS compliat i the future thereby breakig the existig code. XNP_GEO_AREAS_VL The geographic area view provides all the active geographic areas ready for Number Portability. Name Null? Type ROW_ID ROWID GEO_AREA_ID NOT NULL NUMBER GEO_AREA_TYPE_CODE NOT NULL VARCHAR2(10) CODE NOT NULL VARCHAR2(20) ACTIVE_FLAG NOT NULL VARCHAR2(1) CREATED_BY NOT NULL NUMBER(15) CREATION_DATE NOT NULL DATE LAST_UPDATED_BY NOT NULL NUMBER(15) LAST_UPDATE_DATE NOT NULL DATE LAST_UPDATE_LOGIN NUMBER(15) DISPLAY_NAME NOT NULL VARCHAR2(40) DESCRIPTION VARCHAR2(4000) Number Portability Views D-3

192 XNP_MSG_TYPES_VL The Message type view provides the iformatio iterface for Message Types. Name Null? Type ROW_ID ROWID MSG_CODE NOT NULL VARCHAR2(20) MSG_TYPE NOT NULL VARCHAR2(10) STATUS NOT NULL VARCHAR2(10) PRIORITY NOT NULL NUMBER QUEUE_NAME NOT NULL VARCHAR2(40) PROTECTED_FLAG NOT NULL VARCHAR2(1) RESPONSIBILITY_ID NUMBER LAST_COMPILED_DATE DATE VALIDATE_LOGIC VARCHAR2(4000) IN_PROCESS_LOGIC VARCHAR2(4000) OUT_PROCESS_LOGIC VARCHAR2(4000) DEFAULT_PROCESS_LOGIC VARCHAR2(4000) DTD_URL VARCHAR2(4000) CREATED_BY NOT NULL NUMBER(15) CREATION_DATE NOT NULL DATE LAST_UPDATED_BY NOT NULL NUMBER(15) LAST_UPDATE_DATE NOT NULL DATE LAST_UPDATE_LOGIN NUMBER(15) DISPLAY_NAME NOT NULL VARCHAR2(40) DESCRIPTION VARCHAR2(4000) D-4 Product Title/BookTitle as a Variable

193 .. XNP_SV_FE_MAPP_DETAILS_VL This view provides the fulfillmet elemet used to provisio a Number Portability feature for a give SMS etry. It also provides the status of the Provisioig ad the type of the fulfillmet elemet used Name Null? Type SV_SMS_ID NOT NULL NUMBER FEATURE_TYPE NOT NULL VARCHAR2(15) PROVISION_STATUS NOT NULL VARCHAR2(20) PROVISION_STATUS_MEANING NOT NULL VARCHAR2(80) FULFILLMENT_ELEMENT_NAME NOT NULL VARCHAR2(40) DISPLAY_NAME NOT NULL VARCHAR2(80) FULFILLMENT_ELEMENT_TYPE NOT NULL VARCHAR2(40) XNP_SV_ORDER_MAPP_DETAILS_VL This view provides a mappig of Orders ad Work Items that have created or modified a give SOA or SMS portig record. This allows for itegratio of NP to the SDP Flow Through module Name Null? Type ORDER_ID NOT NULL NUMBER SV_SOA_ID SV_SMS_ID WORKITEM_INSTANCE_ID NUMBER NUMBER NUMBER EXTERNAL_ORDER_NUMBER NOT NULL VARCHAR2(40) TELEPHONE_NUMBER VARCHAR2(40) WORKITEM_ID NOT NULL NUMBER WORKITEM_NAME NOT NULL VARCHAR2(40) WI_TYPE_CODE NOT NULL VARCHAR2(40) WI_DISPLAY_NAME NOT NULL VARCHAR2(80) WI_DESCRIPTION VARCHAR2(2000) Number Portability Views D-5

194 . STATUS_CODE NOT NULL VARCHAR2(40) XNP_SV_SMS_V This provides all the etwork data iformatio for the SMS Portig Records Name Null? Type SV_SMS_ID NOT NULL NUMBER PORTING_ID NOT NULL VARCHAR2(80) ROUTING_NUMBER_ID NOT NULL NUMBER SUBSCRIPTION_TN NOT NULL VARCHAR2(20) SUBSCRIPTION_TYPE NOT NULL VARCHAR2(10) MEDIATOR_SP_ID PROVISION_SENT_DATE PROVISION_DONE_DATE CNAM_ADDRESS CNAM_SUBSYSTEM ISVM_ADDRESS ISVM_SUBSYSTEM LIDB_ADDRESS LIDB_SUBSYSTEM CLASS_ADDRESS CLASS_SUBSYSTEM WSMSC_ADDRESS WSMSC_SUBSYSTEM RN_ADDRESS RN_SUBSYSTEM NUMBER DATE DATE VARCHAR2(80) VARCHAR2(80) VARCHAR2(80) VARCHAR2(80) VARCHAR2(80) VARCHAR2(80) VARCHAR2(80) VARCHAR2(80) VARCHAR2(80) VARCHAR2(80) VARCHAR2(80) VARCHAR2(80) CREATED_BY NOT NULL NUMBER(15) CREATION_DATE NOT NULL DATE LAST_UPDATED_BY NOT NULL NUMBER(15) D-6 Product Title/BookTitle as a Variable

195 LAST_UPDATE_DATE NOT NULL DATE LAST_UPDATE_LOGIN NRC_SP_TYPE NRC_CODE NRC_NAME NRC_TIMEZONE NRC_SERVED_BY_FLAG NRC_ADDRESS_LINE1 NRC_CITY NRC_STATE NRC_ZIP_CODE NRC_COUNTRY NRC_PHONE NRC_ADDRESS_LINE2 NRC_MOBILE NRC_FAX NRC_PAGER NRC_PAGER_PIN NRC_ NRC_INTERNET NRC_DEPT ROUTING_REF INTERCONNECT_TYPE ROUTING_SP_ID ROUTING_NUMBER ROUTING_STATUS REC_SP_ID REC_SP_TYPE REC_CODE NUMBER(15) VARCHAR2(20) VARCHAR2(20) VARCHAR2(80) VARCHAR2(10) VARCHAR2(1) VARCHAR2(40) VARCHAR2(40) VARCHAR2(40) VARCHAR2(20) VARCHAR2(40) VARCHAR2(20) VARCHAR2(40) VARCHAR2(20) VARCHAR2(20) VARCHAR2(20) VARCHAR2(80) VARCHAR2(80) VARCHAR2(40) VARCHAR2(80) VARCHAR2(80) VARCHAR2(10) NUMBER VARCHAR2(20) VARCHAR2(10) NUMBER VARCHAR2(20) VARCHAR2(20) Number Portability Views D-7

196 . REC_NAME REC_TIMEZONE REC_SERVED_BY_FLAG REC_ADDRESS_LINE1 REC_CITY REC_STATE REC_ZIP_CODE REC_COUNTRY REC_PHONE REC_ADDRESS_LINE2 REC_MOBILE REC_FAX REC_PAGER REC_PAGER_PIN REC_ REC_INTERNET REC_DEPT VARCHAR2(80) VARCHAR2(10) VARCHAR2(1) VARCHAR2(40) VARCHAR2(40) VARCHAR2(40) VARCHAR2(20) VARCHAR2(40) VARCHAR2(20) VARCHAR2(40) VARCHAR2(20) VARCHAR2(20) VARCHAR2(20) VARCHAR2(80) VARCHAR2(80) VARCHAR2(40) VARCHAR2(80) XDP_OE_ORDER_DETAILS_V View cotaiig the Order etry order details. This view is used for the forms ad as a temporary storage for each lie item iformatio of a order. Name Null? Type ORDER_NUMBER NOT NULL VARCHAR2(40) ORDER_VERSION VARCHAR2(40) LINE_NUMBER NOT NULL NUMBER LINE_ITEM_NAME NOT NULL VARCHAR2(40) LINE_ITEM_VERSION LINE_ITEM_TYPE IS_WORK_ITEM_FLAG VARCHAR2(40) VARCHAR2(20) VARCHAR2(1) D-8 Product Title/BookTitle as a Variable

197 PROVISIONING_REQUIRED_FLAG NOT NULL VARCHAR2(1) ORDER_PROVISIONING_DATE NOT NULL DATE LINE_PROVISIONING_DATE PROVISIONING_SEQUENCE ORDER_TYPE ORDER_ACTION LINE_ITEM_ACTION ORDER_SOURCE ORDER_PRIORITY LINE_PRIORITY ORDER_STATUS LINE_STATUS SDP_ORDER_ID ORDER_DUE_DATE LINE_DUE_DATE ORDER_CUSTOMER_REQUIRED_DATE LINE_CUSTOMER_REQUIRED_DATE CUSTOMER_NAME CUSTOMER_ID ORG_ID SERVICE_PROVIDER_ID TELEPHONE_NUMBER RELATED_ORDER_ID SP_ORDER_NUMBER SP_USERID ORDER_REF_NAME ORDER_REF_VALUE STARTING_NUMBER ENDING_NUMBER DATE NUMBER VARCHAR2(40) VARCHAR2(30) VARCHAR2(30) VARCHAR2(40) NUMBER NUMBER VARCHAR2(40) VARCHAR2(40) NUMBER DATE DATE DATE DATE VARCHAR2(40) NUMBER NUMBER NUMBER VARCHAR2(40) NUMBER VARCHAR2(80) NUMBER(15) VARCHAR2(80) VARCHAR2(300) VARCHAR2(80) VARCHAR2(80) Number Portability Views D-9

198 . XDP_ORDER_DETAILS_V View cotaiig the order details. This view should be used by the users to query the order ad work item iformatio for ay give portig id. The portig id should be first stored i this table i the colum as ORDER_REF_NAME = PORTING_ID ad the value i ORDER_REF_VALUE. I the sceario where the Portig id is received oly later ad ot preset at the time of order submissio, the user ca use the Core API XNP_CORE.SOA_ UPDATE_PORTING_ID to update the object_referece i XNP_SV_SOA, ad order_ ref_ame ad order_ref_value i the XDP_ORDER_HEADERS. Name Null? Type ORDER_ID NOT NULL NUMBER ORDER_NUMBER NOT NULL VARCHAR2(40) ORDER_VERSION VARCHAR2(40) LINE_ITEM_ID NOT NULL NUMBER LINE_NUMBER NOT NULL NUMBER LINE_ITEM_NAME NOT NULL VARCHAR2(40) LINE_VERSION LINE_ITEM_ACTION_CODE VARCHAR2(20) VARCHAR2(30) WORKITEM_INSTANCE_ID NOT NULL NUMBER WORKITEM_ID NOT NULL NUMBER WORKITEM_NAME NOT NULL VARCHAR2(40) WORKITEM_VERSION NOT NULL VARCHAR2(40) WI_TYPE_CODE NOT NULL VARCHAR2(40) ORDER_STATUS_CODE NOT NULL VARCHAR2(40) ORDER_STATE NOT NULL VARCHAR2(40) LINE_STATUS_CODE NOT NULL VARCHAR2(40) LINE_STATE NOT NULL VARCHAR2(40) WORKITEM_STATUS_CODE NOT NULL VARCHAR2(40) WORKITEM_STATE NOT NULL VARCHAR2(40) LINE_SEQUENCE NOT NULL NUMBER D-10 Product Title/BookTitle as a Variable

199 SEQ_IN_PACKAGE NUMBER SERVICE_ID NUMBER PACKAGE_ID NUMBER ORDER_PROVISIONING_DATE NOT NULL DATE LINE_PROVISIONING_DATE DATE ACTUAL_PROVISIONING_DATE DATE ORDER_COMPLETION_DATE DATE LINE_COMPLETION_DATE DATE WORKITEM_COMPLETION_DATE DATE ORDER_CANCEL_PROVISIONING_DATE DATE ORDER_CANCELED_BY VARCHAR2(40) LINE_CANCEL_PROVISIONING_DATE DATE LINE_CANCELED_BY VARCHAR2(40) ORDER_HOLD_PROVISIONING_DATE DATE ORDER_HELD_BY VARCHAR2(40) LINE_HOLD_PROVISIONING_DATE DATE LINE_HELD_BY VARCHAR2(40) ORDER_RESUME_PROVISIONING_DATE DATE ORDER_RESUMED_BY VARCHAR2(40) LINE_RESUME_PROVISIONING_DATE DATE LINE_RESUMED_BY VARCHAR2(40) ORDER_DUE_DATE DATE ORDER_CUSTOMER_REQUIRED_DATE DATE LINE_DUE_DATE DATE LINE_CUSTOMER_REQUIRED_DATE DATE ORDER_ACTION VARCHAR2(30) ORDER_SOURCE VARCHAR2(40) CUSTOMER_ID NUMBER CUSTOMER_NAME VARCHAR2(40) Number Portability Views D-11

200 ORG_ID SERVICE_PROVIDER_ID TELEPHONE_NUMBER ORDER_PRIORITY LINE_PRIORITY RELATED_ORDER_ID ORDER_TYPE NEXT_ORDER_ID PREVIOUS_ORDER_ID ORDER_REF_NAME ORDER_REF_VALUE SP_ORDER_NUMBER SP_USERID STARTING_NUMBER ENDING_NUMBER USER_WF_PROCESS_NAME WF_ITEM_TYPE WF_ITEM_KEY NUMBER NUMBER VARCHAR2(40) NUMBER NUMBER NUMBER VARCHAR2(40) NUMBER NUMBER VARCHAR2(80) VARCHAR2(300) VARCHAR2(80) NUMBER(15) VARCHAR2(80) VARCHAR2(80) VARCHAR2(40) VARCHAR2(8) VARCHAR2(240) XNP_SV_SOA_VL Name Null? Type SV_SOA_ID NOT NULL NUMBER PORTING_ID NOT NULL VARCHAR2(80) SUBSCRIPTION_TN NOT NULL VARCHAR2(20) SUBSCRIPTION_TYPE NOT NULL VARCHAR2(10) DONOR_SP_ID NOT NULL NUMBER RECIPIENT_SP_ID NOT NULL NUMBER STATUS_TYPE_CODE NOT NULL VARCHAR2(20) D-12 Product Title/BookTitle as a Variable

201 PTO_FLAG NOT NULL VARCHAR2(1) CREATED_BY_SP_ID NOT NULL NUMBER CHANGED_BY_SP_ID MEDIATOR_SP_ID ROUTING_NUMBER_ID PRE_SPLIT_SUBSCRIPTION_TN PREV_STATUS_TYPE_CODE CNAM_ADDRESS CNAM_SUBSYSTEM ISVM_ADDRESS ISVM_SUBSYSTEM LIDB_ADDRESS LIDB_SUBSYSTEM CLASS_ADDRESS CLASS_SUBSYSTEM WSMSC_ADDRESS WSMSC_SUBSYSTEM RN_ADDRESS RN_SUBSYSTEM ACTIVATION_DUE_DATE NEW_SP_DUE_DATE OLD_SP_DUE_DATE OLD_SP_CUTOFF_DUE_DATE EFFECTIVE_RELEASE_DUE_DATE NUMBER_RETURNED_DUE_DATE DISCONNECT_DUE_DATE INVOICE_DUE_DATE STATUS_CHANGE_DATE CREATED_DATE NUMBER NUMBER NUMBER VARCHAR2(20) VARCHAR2(20) VARCHAR2(80) VARCHAR2(80) VARCHAR2(80) VARCHAR2(80) VARCHAR2(80) VARCHAR2(80) VARCHAR2(80) VARCHAR2(80) VARCHAR2(80) VARCHAR2(80) VARCHAR2(80) VARCHAR2(80) DATE DATE DATE DATE DATE DATE DATE DATE DATE DATE Number Portability Views D-13

202 D-14 Product Title/BookTitle as a Variable MODIFIED_DATE DATE CONCURRENCE_FLAG VARCHAR2(1) NEW_SP_AUTHORIZATION_FLAG VARCHAR2(1) OLD_SP_AUTHORIZATION_FLAG VARCHAR2(1) RETAIN_DIR_INFO_FLAG VARCHAR2(1) RETAIN_TN_FLAG VARCHAR2(1) BLOCKED_FLAG VARCHAR2(1) LOCKED_FLAG VARCHAR2(1) CUSTOMER_CONTACT_REQ_FLAG VARCHAR2(1) BILLING_ID NUMBER USER_LOCTN_VALUE VARCHAR2(80) USER_LOCTN_TYPE VARCHAR2(20) CHARGING_INFO VARCHAR2(4000) ORDER_PRIORITY VARCHAR2(1) STATUS_CHANGE_CAUSE_CODE VARCHAR2(20) PREORDER_AUTHORIZATION_CODE VARCHAR2(20) CUSTOMER_ID VARCHAR2(80) CUSTOMER_NAME VARCHAR2(80) CUSTOMER_TYPE VARCHAR2(10) CONTACT_NAME VARCHAR2(80) ADDRESS_LINE1 VARCHAR2(40) ADDRESS_LINE2 VARCHAR2(40) CITY VARCHAR2(40) STATE VARCHAR2(40) ZIP_CODE VARCHAR2(20) COUNTRY VARCHAR2(40) PHONE VARCHAR2(20) MOBILE VARCHAR2(20) FAX VARCHAR2(20)

203 PAGER VARCHAR2(20) PAGER_PIN VARCHAR2(80) VARCHAR2(80) INTERNET_ADDRESS VARCHAR2(40) PRICE_CODE VARCHAR2(20) PRICE_PER_CALL NUMBER(15,3) PRICE_PER_MINUTE NUMBER(15,3) CREATED_BY NOT NULL NUMBER(15) CREATION_DATE NOT NULL DATE LAST_UPDATED_BY NOT NULL NUMBER(15) LAST_UPDATE_DATE NOT NULL DATE LAST_UPDATE_LOGIN NUMBER(15) STATUS_PHASE NOT NULL VARCHAR2(20) STATUS_DISPLAY_NAME NOT NULL VARCHAR2(40) STATUS_DESC VARCHAR2(4000) DON_SP_TYPE NOT NULL VARCHAR2(20) DON_CODE NOT NULL VARCHAR2(20) DON_NAME NOT NULL VARCHAR2(80) DON_TIMEZONE NOT NULL VARCHAR2(10) DON_SERVED_BY_FLAG NOT NULL VARCHAR2(1) DON_ADDRESS_LINE1 NOT NULL VARCHAR2(40) DON_CITY NOT NULL VARCHAR2(40) DON_STATE NOT NULL VARCHAR2(40) DON_ZIP_CODE NOT NULL VARCHAR2(20) DON_COUNTRY NOT NULL VARCHAR2(40) DON_PHONE NOT NULL VARCHAR2(20) DON_ADDRESS_LINE2 VARCHAR2(40) DON_MOBILE VARCHAR2(20) DON_FAX VARCHAR2(20) Number Portability Views D-15

204 DON_PAGER VARCHAR2(20) DON_PAGER_PIN VARCHAR2(80) DON_ VARCHAR2(80) DON_INTERNET VARCHAR2(40) DON_DEPT VARCHAR2(80) REC_SP_TYPE NOT NULL VARCHAR2(20) REC_CODE NOT NULL VARCHAR2(20) REC_NAME NOT NULL VARCHAR2(80) REC_TIMEZONE NOT NULL VARCHAR2(10) REC_SERVED_BY_FLAG NOT NULL VARCHAR2(1) REC_ADDRESS_LINE1 NOT NULL VARCHAR2(40) REC_CITY NOT NULL VARCHAR2(40) REC_STATE NOT NULL VARCHAR2(40) REC_ZIP_CODE NOT NULL VARCHAR2(20) REC_COUNTRY NOT NULL VARCHAR2(40) REC_PHONE NOT NULL VARCHAR2(20) REC_ADDRESS_LINE2 VARCHAR2(40) REC_MOBILE VARCHAR2(20) REC_FAX VARCHAR2(20) REC_PAGER VARCHAR2(20) REC_PAGER_PIN VARCHAR2(80) REC_ VARCHAR2(80) REC_INTERNET VARCHAR2(40) REC_DEPT VARCHAR2(80) NRC_SP_TYPE VARCHAR2(20) NRC_CODE VARCHAR2(20) NRC_NAME VARCHAR2(80) NRC_TIMEZONE VARCHAR2(10) NRC_SERVED_BY_FLAG VARCHAR2(1) D-16 Product Title/BookTitle as a Variable

205 NRC_ADDRESS_LINE1 VARCHAR2(40) NRC_CITY VARCHAR2(40) NRC_STATE VARCHAR2(40) NRC_ZIP_CODE VARCHAR2(20) NRC_COUNTRY VARCHAR2(40) NRC_PHONE VARCHAR2(20) NRC_ADDRESS_LINE2 VARCHAR2(40) NRC_MOBILE VARCHAR2(20) NRC_FAX VARCHAR2(20) NRC_PAGER VARCHAR2(20) NRC_PAGER_PIN VARCHAR2(80) NRC_ VARCHAR2(80) NRC_INTERNET VARCHAR2(40) NRC_DEPT VARCHAR2(80) OWN_SP_ID NOT NULL NUMBER OWN_SP_TYPE NOT NULL VARCHAR2(20) OWN_CODE NOT NULL VARCHAR2(20) OWN_NAME NOT NULL VARCHAR2(80) OWN_TIMEZONE NOT NULL VARCHAR2(10) OWN_SERVED_BY_FLAG NOT NULL VARCHAR2(1) OWN_ADDRESS_LINE1 NOT NULL VARCHAR2(40) OWN_CITY NOT NULL VARCHAR2(40) OWN_STATE NOT NULL VARCHAR2(40) OWN_ZIP_CODE NOT NULL VARCHAR2(20) OWN_COUNTRY NOT NULL VARCHAR2(40) OWN_PHONE NOT NULL VARCHAR2(20) OWN_ADDRESS_LINE2 VARCHAR2(40) OWN_MOBILE VARCHAR2(20) OWN_FAX VARCHAR2(20) Number Portability Views D-17

206 OWN_PAGER OWN_PAGER_PIN OWN_ OWN_INTERNET OWN_DEPT ROUTING_REF INTERCONNECT_TYPE ROUTING_SP_ID ROUTING_NUMBER ROUTING_STATUS COMMENTS NOTES VARCHAR2(20) VARCHAR2(80) VARCHAR2(80) VARCHAR2(40) VARCHAR2(80) VARCHAR2(80) VARCHAR2(10) NUMBER VARCHAR2(20) VARCHAR2(10) VARCHAR2(4000) VARCHAR2(4000) D-18 Product Title/BookTitle as a Variable

207 XNP_SV_STATUS_TYPES_VL Name Null? Type ROW_ID ROWID STATUS_TYPE_CODE NOT NULL VARCHAR2(20) PHASE_INDICATOR NOT NULL VARCHAR2(20) ACTIVE_FLAG NOT NULL VARCHAR2(1) INITIAL_FLAG NOT NULL VARCHAR2(1) INITIAL_FLAG_ENFORCE_SEQ NOT NULL NUMBER DISPLAY_SEQUENCE NOT NULL NUMBER CREATED_BY NOT NULL NUMBER(15) CREATION_DATE NOT NULL DATE LAST_UPDATED_BY NOT NULL NUMBER(15) LAST_UPDATE_DATE NOT NULL DATE LAST_UPDATE_LOGIN NUMBER(15) DISPLAY_NAME NOT NULL VARCHAR2(40) DESCRIPTION VARCHAR2(4000) Number Portability Views D-19

208 D-20 Product Title/BookTitle as a Variable

209 E Cofigurig Adapters Cofigurig Adapters E-1

210 E.1 Adapter Architecture Oracle SDP requires iteractio with remote systems & applicatios to perform applicatio level processig. Remote systems & applicatios require that ay iteractio with them happes via well defied iterfaces. These iterfaces are defied via Protocol Data Uits (PDUs) for commuicatio over a certai type of etwork medium. To ecompass a wider rage of remote applicatios, a geeric framework is eeded that will allow commuicatio to happe via: Customized PDUs. Idepedet Network Iterfaces. Sessio Level Cotrol. Extesio of the framework for ay specific eeds. The Adapter framework of Oracle SDP is a framework, writte i Java laguage, that is geeric eough to be customized for most remote applicatio eeds. The framework is made up of compoets that ca be exteded, via derivatio, for specialized applicatios ad protocols. The Adapter framework represets a gateway iterface for exteral commuicatios usig Oracle Provisioig E-2 Product Title/BookTitle as a Variable

211 Adapter Architecture Figure E 1 Remote Commuicatios via Adapters. Oracle SDP (Commuicatio via Adapters) Etheret Remote Cliet Remote Cliet Cofigurig Adapters E-3

212 Adapter Architecture Architecture The architecture of Oracle SDP adapters ca be described as follows: Cotrol Message Moitor Applicatio Message Moitor Iboud Message Moitor Figure E 2 Adapter Processor & Dispatcher Iterface To Oracle SDP DBMS Pipe AQ AQ Cotrol Moitor Applicatio Moitor Iboud Moitor Adapter Processor & Dispatcher Iterface To Remote Systems E-4 Product Title/BookTitle as a Variable

213 Cotrol Message Moitor E.2 Cotrol Message Moitor The cotrol message moitor is resposible for moitorig a DBMS pipe for cotrol messages. The adapters uderstad certai types of cotrol messages for applicatio level cotrol. Some of the cotrol messages are: OPEN CLOSE SHUTDOWN_NORMAL SUSPEND RESUME FTP CLOSEFILE The cotrol messages are iitiated from the Oracle SDP iterals ad acted upo by the adapter. Users ca defie their ow cotrol messages ad exted the adapter framework to iterpret those ew cotrol messages. The ame of the DBMS pipe o which the adapter listes for cotrol messages is the chael ame. The chael ame is passed as a parameter to the adapter durig its ivokatio. The chael ame is supposed to be uique. To ackowledge the receipt of cotrol messages, the adapter itself creates a reply DBMS pipe. The ame of this pipe is always the chael ame alog with _REPLY. For e.g., if the chael ame passed to the adapter durig its ivoke is ATT_12345 the there will be two DBMS pipes created for Cotrol Message Moitorig. The ame of oe DBMS pipe will be ATT_12345 which will carry cotrol messages for the adapter. The other DBMS pipe ame would be ATT_12345_REPLY which will carry ackowledgmet messages from the adapter to the processes of Oracle SDP, that ru iside the DBMS. The cotrol message moitor is a java thread i the mai adapter processor & dispatcher. The thread checks for messages i the DBMS pipe after a delay. The delay ca be fie tued i the adapter.properties file via property Adapter.CotrolMessage delay. Cofigurig Adapters E-5

214 Cotrol Message Moitor Applicatio Message Moitor The applicatio message moitor is resposible for processig applicatio level messages i Oracle SDP. Ulike cotrol message moitor, applicatio message moitor listes o the AQ of Oracle SDP. The AQ, which is resposible for deliverig applicatio messages to the applicatio message moitor, is called a outboud AQ. The AQ ame o which the applicatio message moitor listes o is declared i adapter.properties via property Adapter.OutboudAQ.ame. Applicatio message moitor deques the messages from the outboud AQ usig the adapter ame specified as the cosumer of the AQ. This adapter ame is provided as a parameter whe the adapter is lauched. While processig of a message, if a applicatio error occurs, the applicatio message is ot dequed ad a error is set o the iboud AQ. I case of certai severe error, a error message is set back ad the adapter automatically performs its ow shutdow. e.g., FTP failures durig the FTP of a file via the FileAdapter. The applicatio message moitor is a java thread i the mai adapter processor & dispatcher. The thread checks for messages i the outboud AQ after a delay. The delay ca be fie tued i the adapter.properties file via property Adapter.ApplicatioMessage.delay. Iboud Message Moitor The iboud message moitor is resposible for deliverig messages, from remote applicatios ad processed by the adapter, to Oracle SDP. The iboud message moitor writes the messages to the iboud AQ. The ame of the iboud AQ is determied by the property Adapter.IboudAQ.ame i the adapter.properties file. The iboud message moitor is a java thread i the mai adapter processor & dispatcher. The thread ca be provided a message by the applicatio. The provided message is the dispatched to the iboud AQ from where it is collected by Evet Maager. Adapter Processor & Dispatcher The mai applicatio processig is performed by the Adapter Processor & Dispatcher. The mai fuctioality of the adapter processor is to moitor all the moitors ad dispatch their processig to respective applicatio elemets. The applicatio adapter is a abstract java class that eeds ca be exteded to provide applicatio level fuctioality. The core compoets, the moitors, are available i the base class ad ca be either exteded or used by the derived class. E-6 Product Title/BookTitle as a Variable

215 Cotrol Message Moitor Cotrol Messages Cotrol messages are messages that are processed by the Cotrol Message Moitor. The various OPERATION types defied for cotrol messages i Oracle SDP adapters is as follows: OPERATION OPEN CLOSE SHUTDOWN_NORMAL SUSPEND RESUME FTP (Specific to the FileAdapter) CLOSEFILE (Specific to the FileAdapter) Descriptio Chages the state of the adapter to OPEN. I OPEN state, the adapter is ready to process applicatio level messages. Chages the state of the adapter to CLOSE. I CLOSE state, the adapter does ot process ay applicatio level messages. Chages the state of the adapter to SHUTDOWN. I this mode, the adapter exits as a process with exit code 0. Chages the state of the adapter to SUSPEND. I this state, the adapter does ot process ay applicatio level messages. Chages the state of the adapter to OPEN from a suspeded state. Performs the ftp operatio of the file to a remote server. This cotrol message is a example of user defied cotrol message ad has bee implemeted i the file adapter. Performs the close operatio with respect to a file adapter. The close operatio may require a footer to be writte to the file beig maaged by the file adapter. This user defied cotrol message also istructs the FileAdapter to start processig aother default file. This cotrol message is aother example of a user defied cotrol message ad has bee implemeted i the file adapter. Cofigurig Adapters E-7

216 State Machie E.3 State Machie The base adapter framework provides a base abstract Adapter class. This class ca be exteded from, via derivatio i Java, ad made cocrete by overridig the method performapplicatiomessageprocessig. Cotrol messages dictate the state of the adapter at ay give poit. Followig are the states i the curret adapter framework : Figure E 3 Adapter States OPEN Cotrol Msg CLOSE Cotrol Msg SHUTDOWN_NORMAL Cotrol Msg SHUTDOWN_NORMAL Cotrol Msg SUSPEND Cotrol Msg RESUME Cotrol Msg INITIAL OPEN SUSPEND SHUTDOWN_NORMAL CLOSE E-8 Product Title/BookTitle as a Variable

217 State Machie FE Attributes Fulfillmet Elemet Attributes are required by a adapter implemetatio i order to coect to the remote elemet ad perform its fuctio. A example is the IP address for a file adapter. The IP address is required to coect to the remote machie ad FTP a file. A Fulfillmet elemet ca implemet several Adapter techologies like File ad TCP/IP. All the defied FE attributes will passed to the adapter upo opeig the adapter for commuicatio. The FE attributes are passed as XML elemets i the OPEN message. Please refer to the SDP referece maual o cofigurig FE attributes ad their values. Coect Procedures The coect procedure is executed by the SDP Fulfillmet Elemet Cotroller after spawig a ew adapter. By default the coect procedure will call the API xp_ adapter.ope(), which ca be over ridde by a user defied procedure. The ope API retrieves all the FE attributes, costructs a OPEN message ad seds it to the adapter. The adapter ca use the attributes to implemet the fuctioality. Please refer to the SDP referece maual for more iformatio o the coect ad discoect procedures. Discoect Procedures The discoect procedure is executed by the SDP Fulfillmet Elemet Cotroller before shuttig dow a adapter. By default the discoect procedure will call the API xp_adapter.close(), which ca be over ridde by a user defied procedure. The close API sed a CLOSE message to the adapter. The close for the specific implemetatio ca close the coectio with the remote elemet. Cofigurig Adapters E-9

218 State Machie Framework Java Classes Java classes i the adapter framework are orgaized i package oracle.apps.xp.adapter. There are three mai categories which further classify the framework classes: core - package oracle.apps.xp.adapter.core db - package oracle.apps.xp.adapter.db impl - package oracle.apps.xp.adapter.impl The core package defies all the Java classes resposible for the core framework. The classes of the core package ca be subclassed to provide applicatio fuctioality. The db package defies all the Java classes resposible for ay database iteractio. The DBCoectio ad DBAccess classes, i the db package, are the primitives resposible for performig the database coectio ad performig ay database access. There are also classes i this package resposible for pipe I/O ad AQ I/O. The impl package is the actual implemeted adapters. This package has the file sub-package which icludes the FileAdapter. Alog with the FileAdapter, i the sub-package file, are the classes for FTPCliet ad ScaDirectory. E-10 Product Title/BookTitle as a Variable

219 Class Hierarchy E.4 Class Hierarchy The class hierarchy of the Java classes that are i the core package is as follows: Core AdapterIF ObservableMessage Adapter IcomigMessage ApplicatioMessage CotrolMessage MessageObserver ObserveApplicatioMessage ObserveIcomigMessage ObserveCotrolMessage Cofigurig Adapters E-11

220 Class Hierarchy Java Core Package Followig Java classes make up the core package: AdapterIF - Iterface class for ay adapter framework Adapter - abstract class, implemets AdapterIF ObservableMessage - abstract class, exteds Observable, implemets Ruable MessageObserver - abstract class, implemets Observer, has ObservableMessage IcomigMessage - cocrete class, exteds ObservableMessage ad implemets the ru() method ApplicatioMessage - cocrete class, exteds ObservableMessage ad implemets the ru() method CotrolMessage - cocrete class, exteds ObservableMessage ad implemets the ru() method ObserveApplicatioMessage - cocrete class, exteds the MessageObserver ad implemets the update() method ObserveIcomigMessage - cocrete class, exteds the MessageObserver ad implemets the update() method ObserveCotrolMessage - cocrete class, exteds the MessageObserver ad implemets the update() method MessageParser - sigleto class, has the primitives to parse a XML message FileMaager - sigleto class, has all the primitives to perform file level operatios clustered together E-12 Product Title/BookTitle as a Variable

221 Class Hierarchy Adapter Class The Adapter class, i the package core, is the base class for all adapter implemetatios. Overridig implemetatios should exted this class ad implemet the abstract methods. Overridig implemetatios ca also override default public & protected iterfaces of this class. The followig public methods are available as iterfaces of the Adapter class: Public Methods Retur Type Method Name Descriptio boolea boolea Ope(Object amessage, Hashtable aparsedetries) Close(Object amessage, Hashtable aparsedetries) This method is ivoked whe a cotrol message of type OPEN is received by the adapter. The iput parameter amessage is of type MessageIF ad aparsedetries is the key/value pairs of the amessage i a parsed format. This method represets the OPEN state of the adapter. The default behavior of this method, as implemeted, is to retur true. This method is ivoked by the hadlecotrolmessage method. If the implemetatio returs a true value the everythig is cosidered ormal. Implemetatio class ca override this method to perform ay iitial etwork coectios or iitializatio. This method is ivoked whe a cotrol message of type CLOSE is received by the adapter. The iput parameter amessage is of type MessageIF ad aparsedetries is the key/value pairs of the amessage i a parsed format. This method is ivoked by the hadlecotrolmessage method. If the implemetatio returs a true value the everythig is cosidered ormal. The implemetatio class ca override this method to perform ay close o etwork coectios or files. Cofigurig Adapters E-13

222 Class Hierarchy boolea boolea Resume(Object amessage, Hashtable aparsedetries) Susped(Object amessage, Hashtable aparsedetries) This method is ivoked whe a cotrol message of type RESUME is received by the adapter. The iput parameter amessage is of type MessageIF ad aparsedetries is the key/value pairs of the amessage i a parsed format. This method is ivoked by the hadlecotrolmessage method. If the implemetatio returs a true value the everythig is cosidered ormal. The implemetatio class ca override this method to perform ay re-opeig of etwork coectios which might have bee closed whe a SUSPEND message had arrived. This method is ivoked whe a cotrol message of type SUSPEND is received by the adapter. The iput parameter amessage is of type MessageIF ad aparsedetries is the key/value pairs of the amessage i a parsed format. This method is ivoked by the hadlecotrolmessage method. If the implemetatio returs a true value the everythig is cosidered ormal. The implemetatio class ca override this method to perform ay closig of etwork coectios upo the receipt of this message. E-14 Product Title/BookTitle as a Variable

223 Class Hierarchy boolea void ShutdowNormal(Object amessage, Hashtable aparsedetries) hadlecotrolmessage(object amessage) This method is ivoked whe a cotrol message of type SHUTDOWN is received by the adapter. The iput parameter amessage is of type MessageIF ad aparsedetries is the key/value pairs of the amessage i a parsed format. This method is ivoked by the hadlecotrolmessage method. If the implemetatio returs a true value the everythig is cosidered ormal. The implemetatio class ca override this method to perform ay cleaup operatios before the adapter is shutdow. This is the method that is ivoked upo receipt of ay Cotrol message. Implemetatio class ca override this method to provide a state machie for cotrol messages. boolea iitialize(strig aargumets[]) This method iitializes data of the base adapter. The argumets to this method are the same argumet array provided to the mai of the implemetatio. If you do override this method i the implemetatio class, the make sure to ivoke the super.iitialize with appropriate argumets. Cofigurig Adapters E-15

224 Class Hierarchy File Adapter Class File Adapter provides a implemetatio of the adapter framework. To provide a implemetatio of the adapter framework, the implemetatio class has to exted the base Adapter class, from the core package, ad override the method performapplicatiomessageprocessig. Alog with that, the implemetatio has a choice of several methods it ca override or exted to provide applicatio level fuctioality. The followig public & protected member methods have bee either exteded or provided by FileAdapter.java: Public Methods Retur Type Method Name Descriptio boolea boolea boolea Ope(Object amessage, Hashtable aparsedetries) performcotrolmessageproces sig(object amessage, Hashtable aparsedetries) performapplicatiomessagepr ocessig(object amessage) The iput parameter amessage is of type MessageIF ad aparsedetries is the key/value pairs of the amessage i a parsed format. This method represets the OPEN state of the adapter. This method belogs to the base adapter class ad has bee overridde i the FileAdapter. The reaso this method has bee overridde is because of the followig: It ivokes createfilename method to create the ame of a file if FILE_ NAME is ot provided. It ivokes createheader to create the header that eeds to be writte i a ewly created file. This method belogs to the base adapter class ad has bee overridde i the FileAdapter. This method is ivoked for user defied cotrol messages. The user defied cotrol messages are FTP ad CLOSEFILE i the case of FileAdapter. This is the ONLY abstract method i the base adapter class. I the case of FileAdapter, the messages, of type MessageIF, are writte to a file that ca be FTPed. E-16 Product Title/BookTitle as a Variable

225 Class Hierarchy boolea performscadirectory(object amessage, Hashtable aetries) Will ivoke the iitializescadirectory to iitiate a scaig thread. This scaig thread is what s called the Iboud Message Moitor void iitializescadirectory() I case of file adapter, istatiates a ew ScaDirectory class ad assigs it to itsscadirectory a protected member of FileAdapter class ad of type ScaDirectory. Protected Methods Retur Type Method Name Descriptio Strig getabsolutefilenamebasedo HomeDir(Strig afilename) Will apped the HOMEDIR (FE Attribute) to the fileame ad retur the ew file ame. Cofigurig Adapters E-17

226 Class Hierarchy FE Attributes for a File Adapter The followig FE attributes have to be defied for the file adapter. Attribute Name HOMEDIR IP_ADDRESS PORT USER_ID PASSWORD REMOTEDIR OUT_ARCHIVE_DIR SCANDIR IN_ARCHIVE_DIR Remarks The home directory is used to hold the file beig costructed. The IP address of the remote machie to which the file will be uploaded. The port o which the remote FTP server is ruig. Stadard port is 21. The remote user o the remote machie. Password for the user. The remote directory is the directory o the remote machie to which the ewly costructed file will be uploaded. The directory i which the file will be archived after the FTP. The directory from which files will be read ad set to SDP for processig. The directory to which the file will be archived after the adapter reads it. Extedig the File Adapter The File Adapter ca be exteded to provide user level fuctioality. Source for MyFileAdapter.java: package examples.file; import java.util.hashtable; import oracle.apps.xp.adapter.impl.file.scadirectory; import oracle.apps.xp.adapter.impl.file.fileadapter; import oracle.apps.xp.adapter.db.messageif; import oracle.apps.xp.adapter.core.adapter; import examples.file.myscadirectory; public class MyFileAdapter exteds FileAdapter { E-18 Product Title/BookTitle as a Variable

227 Class Hierarchy public MyFileAdapter() { super(); } public StrigBuffer createfooter() { StrigBuffer abuffer = ew StrigBuffer(); abuffer.apped("/* TRAILER FOR FTP (C) ORACLE CORPORATION */\"); retur(abuffer); } public StrigBuffer createheader() { StrigBuffer abuffer = ew StrigBuffer(); abuffer.apped("/* START OF HEADER */\"); abuffer.apped("/* HEADER FOR FTP (C) ORACLE CORPORATION */\"); abuffer.apped("/* CONTENTS OF THIS FILE ARE ENCRYPTED */\"); abuffer.apped("/* END OF HEADER */\"); retur(abuffer); } (Cotiued o ext page) (Cotiued from previous page) public Strig createfilename() { /* Should retur a absolute file ame ad ot a relativefile ame. e.g., absolute file ame: /export/home/user1/mydata */ retur(super.createfilename()); } public Strig performmessagetrasformatio(object amessage) { /* The iput argumet, amessage, is always of type MessageIF. RULES: a. Retur a trasformed strig after you have trasformed the message. b. The trasformed message gets writte to the file. c. If you do t wat this message to go to the file, just retur(ull); Cofigurig Adapters E-19

228 Class Hierarchy */ MessageIF anewmessage = (MessageIF)aMessage; retur(anewmessage.tostrig()); } (Cotiued o ext page) (Cotiued from previous page) public void iitializescadirectory() { /* Specialize my ow scaer */ itsscadirectory = ew MyScaDirectory(itsProperties); } public static void mai(strig [] aargs) { Adapter aadapter = ew MyFileAdapter(); if (aadapter.iitialize(aargs)) { if (aadapter.ivokecotrol()) { if (aadapter.ivokeapplicatio()) { System.err.pritl("Adapter lauched!"); } else { System.err.pritl("Failed to ivoke applicatio!"); } } else { System.err.pritl("Failed to ivoke applicatio!"); } } else { (Cotiued o ext page) (Cotiued from previous page) System.err.prit("Wrog umber of argumets: "); for (it i = 0; i < aargs.legth; i++) E-20 Product Title/BookTitle as a Variable

229 Class Hierarchy { if (i > 0) { System.err.prit(" "); } System.err.prit(aArgs[i]); } System.err.pritl(); } } }; Source for MyScaDirectory.java: package examples.file; import java.lag.strig; import java.util.properties; import oracle.apps.xp.adapter.impl.file.scadirectory; public class MyScaDirectory exteds ScaDirectory { public MyScaDirectory(Properties aproperties) { super(aproperties); } public Strig performmessagetrasformatio( Strig afilename, it amessagenumber, Strig amessage) { /* afilename - Is the file ame from which this message has bee extracted. amessagenumber - Is the idex of the message. Begis at 0. amessage - The message retrieved. If you retur a ull from this method, the the message is ot set at all o the iboud Q. So to igore header ad trailer messages, just retur ull. */ retur(super.performmessagetrasformatio(afilename, amessagenumber,amessage)); } }; Cofigurig Adapters E-21

230 Class Hierarchy Extedig Adapters To exted the base FileAdapter, the followig eed to be performed: Derive from the class FileAdapter. e.g., public class MyFileAdapter exteds FileAdapter I the costructor of MyFileAdapter make sure super() is ivoked. The followig methods ca be overridde: Retur Type Method Name Descriptio Script Adapter StrigBuffer createfooter() The footer that ca be writte to a file whe a CLOSEFILE operatio is performed. StrigBuffer createheader() The header that ca be writte to a file whe the first OPEN operatio o the adapter is performed. Strig createfilename() Create the ame of the file as desired. This fuctio is ivoked whe a default file eeds to be created. Strig performmessagetrasformatio (Object amessage) If a applicatio message eeds to be trasformed, the override this method to provide trasformatio of choice. void iitializescadirectory() If you write your ow scaer, the thread resposible for Iboud Message Moitor, the istatiate the scaer by overridig this method. The scaer istatiatio should be assiged to itsscadirectory member. The Script Adapter has bee provided here i the form of source code as a example of how to write ew adapters. E-22 Product Title/BookTitle as a Variable

231 Class Hierarchy Source for ScriptAdapter.java: package oracle.apps.xp.adapter.impl.script; import java.lag.strig; import java.lag.rutime; import java.lag.process; import java.lag.exceptio; import java.util.hashtable; import java.io.iputstream; import java.io.ioexceptio; import oracle.apps.xp.adapter.core.adapter; import oracle.apps.xp.adapter.db.tracelog; public class ScriptAdapter exteds Adapter { public ScriptAdapter() { super(); } public boolea performapplicatiomessageprocessig(object amessage) { retur(true); } public boolea performcotrolmessageprocessig( Object amessage, Hashtable aparsedetries) { Strig aoperatio = (Strig)aParsedEtries.get("OPERATION"); (Cotiued o ext page) (Cotiued from previous page) Rutime arutime = Rutime.getRutime(); try { Process aprocess = arutime.exec(aoperatio); IputStream aiput = aprocess.getiputstream(); it aread = 0; byte abyte[] = ew byte[4096]; TraceLog.write(itsUiqueID,"ScriptAdapter:performCotrolMessageProcessig: Cofigurig Adapters E-23

232 Class Hierarchy Output from the OPERATION: " + aoperatio,tracelog.informational); while(true) { try { aread = aiput.read(abyte); } catch(ioexceptio aexceptio) { break; } if (aread == -1) { /* EOF */ break; } else { Strig astrig = ew Strig(aByte,0,aByte.legth); TraceLog.write(itsUiqueID,"ScriptAdapter:performCotrolMes (Cotiued o ext page) (Cotiued from previous page) sageprocessig: " + astrig,tracelog.informational); } } aprocess.waitfor(); } catch(exceptio aexceptio) { TraceLog.write(itsUiqueID,"ScriptAdapter:performCotrolMessageProcessig: A exceptio was geerated: " + aexceptio.tostrig(),tracelog.informational); } retur(true); } public static void mai(strig [] aargs) { Adapter aadapter = ew ScriptAdapter(); E-24 Product Title/BookTitle as a Variable

233 Class Hierarchy if (aadapter.iitialize(aargs)) { if (aadapter.ivokecotrol()) { System.err.pritl("Adapter lauched!"); } else { System.err.pritl("Failed to ivoke applicatio!"); } } else ued from previous page) System.err.prit("Wrog umber of argumets: "); for (it i = 0; i < aargs.legth; i++) { if (i > 0) { System.err.prit(" "); } System.err.prit(aArgs[i]); } System.err.pritl(); } } }; Cofigurig Adapters E-25

234 Class Hierarchy FE Attributes for a Script Adapter The followig FE attributes have to be defied for the file adapter. Attribute Name IP_ADDRESS PORT USER_ID PASSWORD Remarks The IP address of the remote machie o which the commad is to be executed. The port o which the telet server is ruig. Stadard port is 23. The remote user o the remote machie. Password for the user. E-26 Product Title/BookTitle as a Variable

235 Frequetly Asked Questios E.5 Writig New Adapters Writig ew adapters usig the Adapter Framework is straightforward. To start with, study the Script & File Adapter source code ad follow the guidelies metioed i this sectio. Followig is a step-wise wizard that will allow the developmet of ew adapters usig the adapter framework: Derive from the Adapter class. e.g., public class MyAdapter exteds Adapter Override the method performapplicatiomessageprocessig Override ay other method from the base Adapter class as eeded Write a mai, just like the oe, as metioed i the source of Script & File Adapter Make sure the CLASSPATH is set to pick up the respective jar & zip files Make sure the adapter.properties file has bee cofigured with the right property values Ivoke the adapter ad check for traces i the trace file ame E.6 Frequetly Asked Questios Q. What does a coect procedure look like? A. The followig is a example of a coect procedure: (Service->Fulfillmet Elemets->SW Versios->Details - has the coect procedure (Add/Edit procedure) xp_adapter.ope(fe_ame, chael_ame, sdp_iteral_err_code, sdp_ iteral_err_str); Q. What does a discoect procedure look like? A. The followig is a example of a discoect procedure: (Service->Fulfillmet Elemets->SW Versios->Details - has the discoect procedure (Add/Edit procedure) xp_adapter.close(fe_ame, chael_ame, sdp_iteral_err_code, sdp_iteral_ err_str); Cofigurig Adapters E-27

236 Frequetly Asked Questios Q. Do I eed the coect/discoect procedures? A. Yes. You do eed the coect ad discoect procedure as they perform specialized fuctioality. Q. How are the messages from the outboud Q dequeued? A. The messages are dequeued from the outboud Q usig the adapter ame. The adapter ame is used to queue the messages i the outboud Queue. The place to cofigure this i the GUI is: Admiistratio->Coectio Maagemet Utility. Select the Fulfillmet Elemets (o the left drop list) ad click o the tab Adapters. Make sure that there is oly *oe adapter* per FE. Usually, provide the adapter ame same as that of the FE ame. Q. Whe desigig a message i imessagestudio, I selected the "Test Message" tab ad the selected the (list of values) Cosumer List. From the cosumer list, I picked the FE ame which will process the message. But it seems that the messages (messages i the outboud Q) are dequeued based o the adapter ame. How does this co-relatio take place? A. Whe the message is queued, the "adapter ame" provided for the FE is extracted ad used for queuig. Make sure that you choose the right FE ame for which you have cofigured a adapter ame. Q. How ca I override base adapter methods ad write my ow adapter? A. Perform the followig: Derive the ew adapter class from the base adapter class. E-28 Product Title/BookTitle as a Variable

237 Frequetly Asked Questios Override methods i the derived class which implemet your fuctioality. Compile your class. So for e.g., if your class is amed MyClass ad is part of the package mycom.adapter the the absolute path ame for your class would be mycom.adapter.myclass. Now cofigure your adapter usig the GUI s Fulfillmet Elemet. (Service->Fulfillmet Elemet). You have to defie a ew attribute for the adapter (Service->Fulfillmet Elemet->SW Versio->Attributes) amed IMPLEMENTATION_CLASS. The value of this attribute will be the exact path ame of your implemeted class. i.e., IMPLEMENTATION_CLASS mycom.adapter.myclass Q. What is the ame of the log file geerated by Java based adapters? A. The ame of the file has a prefix of AdapterLog. The rest of the ame is depedet o the chael ame. Q. How is the class IcomigMessage implemeted or exteded? How ca I specify my ow method of receivig messages ad put them i the iboud queue? A. The Icomig Message eeds to be implemeted as follows: 1. Derive a class from IcomigMessage class: class MyIcomigMessage exteds IcomigMessage { }; 2. Use the costructor of MyIcomigMessage has Properties as a sigle argumet: class MyIcomigMessage exteds IcomigMessage { public MyIcomigMessage(Properties aproperties) { } }; Cofigurig Adapters E-29

238 Frequetly Asked Questios 3. Provide a method "performactio" that either returs a message of type MessageIF or a Vector of MessageIF: public Object performactio() { a. Perform your processig. b. If error, set: 1. itserror(type boolea iherited from IcomigMessage) to "true". (itserror = true) 2. itserrordescriptio(type Strig iherited from IcomigMessage) to a descriptive descriptio. e.g. itserrordescriptio = "I caot process somethig"; 3. retur(ull); c. If everythig is ormal the retur(either a sigle MessageIF or a Vector of MessageIF); } 4. Provide a method "performpostactio" that returs either a "true" or "false". The purpose of this method is that if you wat to perform some post processig after "performactio" the you ca do it here. Otherwise, o eed to provide this method. I most cases, you ll ot be eedig this method. 5. Perform the followig i you class that has the mai adapter code: i.e., class MyAdapter exteds Adapter { }; a. Override the method Ope: class MyAdapter exteds Adapter { protected MyIcomigMessage itsmyicomigmessage = ull; public boolea Ope(Object amessage, Hashtable aetries) { 1. Extract ay FE attributes you eed for saity checks from aetries. 2. Istatiate & iitialize the MyIcomigMessage class: e.g., itsmyicomigmessage = ew MyIcomigMessage(itsProperties); // itsproperties is iherited from Adater class itsmyicomigmessage.iitialize() { itsmyicomigmessage.setfeattributes(somethig); E-30 Product Title/BookTitle as a Variable

239 Frequetly Asked Questios // if you wat to set ay attributes the // write a method amed setfeattributes for // class MyIcomigMessage ad ivoke them here. itsicomigmessage = itsmyicomigmessage; // itsicomigmessage is iherited from Adapter // class. Perform this assigmet. itsicomigmessagemoitor = ew ObserveIcomigMessage(this, itsicomigmessage); // itsicomigmessagemoitor is iherited from // Adapter. The above statemet iitializes ad // starts the IcomigMessage thread so that it // polls the "performactio" method defied i // class MyIcomigMessage. } retur(true); } }; The mai poits for a Icomig Message thread are: After the "itsicomigmessagemoitor" variable is istatiated, the "IcomigMessage" thread is lauched. (the "ru" method of the thread is ow i a ifiite loop with a delay that ca be customized). The "IcomigMessage" thread ivokes the "performactio" method as defied i MyIcomigMessage from the "ru" loop. Based o what s retur ad error coditios, it either puts the retured cotets i the Iboud AQ or shuts the adapter dow because of error. Q Ca the method performapplicatiomessageprocessig of class "FileAdapter be overloaded? A. Yes, the method performapplicatiomessageprocessig ca be overloaded. However, the method has a "sychroized" specifier for its access. (I the class FileAdapter). So if you do pla to override this method, make sure you make it "sychroized" as well. Cofigurig Adapters E-31

240 Frequetly Asked Questios E-32 Product Title/BookTitle as a Variable

241 F Implemetig Number Portability Process Sychroizatio Implemetig Number Portability Process Sychroizatio F-1

242 F-2 Product Title/BookTitle as a Variable

243 Implemetig Number Portability Process Sychroizatio Implemetig Number Portability Process Sychroizatio Oracle Number Portability is a frame work to implemet Number Portig busiess processes. Oracle Provisioig framework is used to execute these busiess processes as idividual NP lie items processes which execute a pre-cofigured NP workitem workflow. The idividual workflows are capable of hadlig the portig process for a sigle rage of telephoe umbers (TNs) I the cotext of portig multiple rages of TNs simultaeously, the followig requiremets eed to be satisfied The workflows which port the idividual TNs rages, must sychroize with each other i.e., at certai poits withi the busiess process, each workflow must wait ad proceed oly with all the other portig processes have successfully reached the same state. If ay of the other portig process had failed i the meawhile the, all the processes must go to error state. Failure to sychroize after a fiite time, must trigger a error process i all workflows ad the portig processes must error out with the statuses updated appropriately for all. The portig process for all the TNs must be treated as a sigle order. This would mea, that all the idividual workitems must maitai state that it is a part of a whole multiple TN rage port order ad must be treated likewise by the service providers ad the CRDC. The messages set out to the NRC ad SPs must idicate that it belogs to a part of a Multiple TN Rage port order. There should be a provisio to sed a sigle message per TN to the legacy system which the TN rage portig process iterfaces with. I a typical Number Portability sceario, oe of the Service Providers (SPs) will iitiate a request to Port. Implemetig Number Portability Process Sychroizatio F-3

244 Implemetig Number Portability Process Sychroizatio Defiitios The followig are items to be defied for sychroizatio: SDP Order - The user s etry poit to the SDP frame work. The order ca be a request to provisio etwork elemet or NP request with all the ecessary parameters. SDP Work Item - The SDP order is implemeted usig smaller fuctioal uits called work items SDP Lie Item - The lie item is a abstractio for the workitems ad is used to group a buch of workitems implemetig a commo busiess goal. Evet Maager The Evet Maager is a geeric Publish-Subscribe module which registers iterest of various subscribers to differet evet types. The subscriber could be a Traslator (i which case the evet gets propagated as a ew order), Workflow Egie (i which case the evet restarts a Workflow which is waitig o a exteral evet) or a API. imessage Studio The Oracle Provisioig framework for defiig messages. Provides support for defiig message details, elemets, structure, data source, processig logic ad test messages. Timers - A geeric framework of process ad activity level timers provided by Oracle NP-OP which ca be easily itegrated to the NP busiess process. Number Resource Ceter (NRC) - This is the cetral system which admiisters the portig trasactios betwee the Service Providers. Door Service Provider - The Service Provider from which the subscriber wishes to port out from. Recipiet Service Provider - The Service Provider who gets assiged the portable umber rage after the portig takes place. I most cases, it is the recipiet who iitiates the portig trasactio. The request is routed to the Door SP either directly or through the NRC. Iitiatio Phase - The phase i the portig process which spas from submissio of the portig request to the state whe both operators cocur to port. Activatio Phase - The phase begiig from the ed of iitiatio phase to the begiig of the etwork provisioig. F-4 Product Title/BookTitle as a Variable

245 Implemetig Number Portability Process Sychroizatio Major Features Multiple TN rage portig request requiremets are satisfied by havig the followig features built withi the NP-SDP framework Provisio to group multiple TN rage orders at both Door SP ad Recipiet SP eds as lie items of the same order. Provisio to sychroize betwee multiple istaces of same workflow with the same sychroizatio label (defied later). Provisio to cotrol the wait to sychroize period usig Timers. Provisio to sed 1 message per TN to the legacy system by allowig the user to defie legacy system messages usig the imessage Studio. The imessage Studio geerated Sed procedures could be used to sed the legacy system messages. Order Submissio Oracle NP Order Submissio at the Recipiet Service Provider Ed The Multiple TN rage portig order is submitted by the recipiet service provider usig the SDP s Process_Order() API by treatig each Number Rage Portig request as a lie item which directly maps to a workitem workflow. Each lie item is give a sequece umber ad forms part of the same order. The exact sytax for this is provided i the Number Portability Referece Guide. Additioally, the followig thigs eed to be icorporated as part of the order submissio Set the workitem parameter RANGE_COUNT for each workitem ad value i it will be the Port-i lie item umber. Immediately, after the Process_Order() fuctio returs the Order id, call the API to register for sychroizatio betwee lie items passig it the order id (SYNC_REGISTER) Esure that database commit is made oly after SYNC_REGISTER is ivoked. Oracle NP Order submissio at the Door Service Provider ed A Multiple Number rage Port-Out request comes to the door service provider as multiple messages each givig iformatio o a sigle umber rage. Additioally, the commets2 of the Number Portig Request (NPR) message would cotai iformatio idicatig that its a part of a whole multiple umber rage request. The followig figure idicates how a NPR message would look like. At the door ed, a NP Port Out order must be costructed by collatig the iformatio i each of these messages ad the submitted as oe sigle order. I Implemetig Number Portability Process Sychroizatio F-5

246 Implemetig Number Portability Process Sychroizatio this case too, each port out request will be a lie item of a multiple umber rage port out order. The Order Number must be uiquely geerated. This may be geerated by a combiatio of the istallatio id, door sp. code ad recipiet sp. code. I order to collate the iformatio, the iformatio i each message is extracted ad stored as order ad lie items i SDP Order Etry tables. Whe all the messages pertaiig to this multiple TN rage port out order have bee received, the iformatio is collated ad submitted as oe sigle order. APIs to collate the order, order lie iformatio from these order etry tables ad submit already exist ad are packaged as part of SDP. F-6 Product Title/BookTitle as a Variable

247 Implemetig Number Portability Process Sychroizatio Sychroizatio at Check Poits O submissio of the Multiple TN rage portig order, the workitems execute their activities idepedet of each other util the first sychroizatio poit is reached. I the NP sceario, the sychroizatio poits are at the ed of Iitiatio Phase ad Activatio phase for both the Door ad Recipiet operators. At these sych poits, the workflow waits for the other workflows to successfully reach their sych poits. The wait is for a fiite iterval ad after that, the workflows automatically time out a trace a time out path. To eable sychroizatio betwee multiple workflows, they must register with a sych table prior to start. I the NP sceario, this is doe immediately after the Process_Order() API is ivoked by callig the SYNC_REGISTER() fuctio. The SYNC_REGISTER() fuctio the geerates a uique sychroizatio label usig the order id ad lie item ame ad registers the umber of participats agaist this label. The differet sychroizig lie items ad the umber of participats per lie item are looked up usig the order id. The registratio i the case of say, three participats would like the followig i the syc table. Table F 1 Syc. Table - after registratio Syc. Label No. of participats Participats ot i Syc. Status SL1 3 3 Active Implemetig Number Portability Process Sychroizatio F-7

248 Implemetig Number Portability Process Sychroizatio Suy Day Sceario A typical workflow which sychroizes with the others looks like the followig oe Update Process Status (Sych Error) SYNC_ERR Fuctio Activity 1 Sychroise Request SYNC Fuctio Activity SYNC_TIMER Update Process Status (Timed Out) Whe the first workflow waits to sych with the others, a Sychroize Request) fuctio is called with the Sych label passed as a parameter. This will decremet the umber of participats by oe ad if the status of the label is still Active the subscribe for the for the followig evets. SYNC with referece id = sych label ame + activity label (or id) SYNC_ERR with referece id = sych label ame + activity label (or id) SYNC_TIMER with referece id = sych label ame + activity label (or id) F-8 Product Title/BookTitle as a Variable

249 Implemetig Number Portability Process Sychroizatio This is with the give sych label cocateated with activity label as the referece id. Now the Sych table will look as follows Table F 2 Syc. Label Syc. Table - after first sych wait No. of participats Participats ot i Syc. Status SL1 3 2 Active Similarly after the secod participat sychroizes, the table will ow look as follows Table F 3 Syc. Label Syc. Table - after secod sych wait No. of participats Participats ot i Syc. Status SL1 3 1 Active Whe the third workflow reaches the syc poit, it otices that it was the last to sychroize. So it publishes a SYNC evet with the Sych label + activity id as the referece id ad resets the Participats ot i Syc to the value i No. of participats. So ow the table is ready for the workflows to go ahead ad repeat the same sceario at the subsequet sych poits Table F 4 Syc. Label Syc. Table - after all three participats sychroized No. of participats Participats ot i Syc. Status SL1 3 3 Active Whe the SYNC evet gets published with the referece id as the sych label, the evet maager picks it up ad delivers it to both the waitig workflows. Sice the sychroized workflows are resumed by the evet maager ad ot by the last sychroizig workflow, all workflows ca proceed i parallel oce sychroized. Implemetig Number Portability Process Sychroizatio F-9

250 Implemetig Number Portability Process Sychroizatio Error Sceario I case, oe of the workflows, the secod oe say, ecouters ad error after executig the Fuctio Activity 1 the, the first thig it does is to reset the Syc. Table status agaist this label to Error. So the table would look like the followig Table F 5 sychig Syc. Table - after first workflow syched ad secod oe erred before Syc. Label No. of participats Participats ot i Syc. Status SL1 3 1 Error I this case, the third workflow Syc Fuctio otices that the Sych. label status is Error. So, after decremet the Parties ot i syc, it publishes a SYNC_ERR message with the referece id set to the Syc label activity id ad completes itself alog the SYNC_ERR path. The published SYNC_ERR evet is picked up by the evet maager ad delivered to the first workflow which is waitig for the others to sych. So the first workflow too traces the SYNC_ERR path. I the NP sceario, the SYNC_ERR path would cotai a activity which updates the status of the portig trasactio to idicate that the Portig failed ad the status chage cause code metios that the failure was because a peer portig workflow had failed. Time-out Sceario I case the first workflow timed out before ay of the other two reached the sych poit. It would have picked up the SYNC_TIMER evet ad traced the SYNC_ TIMER path. The processig logic of the SYNC_TIMER evet, would reset the status of the Sych label to ERROR. So the table after the processig logic is executed would look like this Table F 6 sychig Syc. Label Syc. Table - after first workflow syched ad secod oe erred before No. of participats Participats ot i Syc. Status SL1 3 2 Error Whe the ext two workflows looks up to sych, they otice that they eed to trace the SYNC_ERR path. So the treatmet will similar to the earlier sceario. F-10 Product Title/BookTitle as a Variable

251 Implemetig Number Portability Process Sychroizatio User Procedures Template ad Algorithms This sectio expads o the iformatio you summarized i the Major Features sectio. It outlies the procedures users should follow to use the features of your applicatio fuctio. It refers users to other maual sectios, such as form ad report descriptios, for more detailed iformatio o how to implemet those procedures. Template for Order Submissio at Recipiet ed Note: Order is costructed as lie items, Process_Order is ivoked ad the Syc. Register is doe. CREATE OR REPLACE PROCEDURE OMS_ORDER IS l_error_code NUMBER := 0; l_error_message VARCHAR(2000); l_order_header XDP_TYPES.ORDER_HEADER; l_order_parameter_list XDP_TYPES.ORDER_PARAMETER_LIST; l_order_lie_list XDP_TYPES.ORDER_LINE_LIST ; l_lie_param_list XDP_TYPES.LINE_PARAM_LIST ; l_order_id NUMBER := 0; l_portig_id NUMBER := 0; l_portig_date date := SYSDATE; l_ca_portig_date varchar2(40) := NULL; BEGIN -- Order Level Iformatio -- Geerate a Order Number SELECT XDP_ORDER_ID_SEQ.NEXTVAL INTO l_order_id FROM DUAL; -- The followig is a example to geerate the order o. -- I reality the order umber must have a more meaig -- value by cocateatig the startig ad edig umber or -- by extractig other elemets from the received message l_order_header.order_umber := XNP_ to_char(l_order_id); l_order_header.order_versio := 1 ; -- Set the SYNC_REQD_FlAG as TRUE -- Iformatio o Order Lie Items /* Treat each umber rage as a order lie item which maps * directly to a workitem workflow. Set the values for each Implemetig Number Portability Process Sychroizatio F-11

252 Implemetig Number Portability Process Sychroizatio * parameter required by the workitem ad the call process order() */ -- Repeat the followig for each lie item. Icremet the -- lie item cout variable i for additioal lie item l_order_lie_list(i).lie_umber := i; l_order_lie_list(i).provisioig_required_flag := 'Y'; l_order_lie_list(i).provisioig_date := SYSDATE; -- Set the lie item ame as the workitem ame l_order_lie_list(i).lie_item_ame := 'PORTING_ORDER_FROM_OMS'; l_order_lie_list(i).is_workitem_flag := 'Y'; -- Set all the parameters eeded for the portig iquiry l_lie_param_list(1).lie_umber := i; l_lie_param_list(1).parameter_ame := 'STARTING_NUMBER'; l_lie_param_list(1).parameter_value := ' '; l_lie_param_list(2).lie_umber := i; l_lie_param_list(2).parameter_ame := 'ENDING_NUMBER'; l_lie_param_list(2).parameter_value := ' ';.. Set ay additioal parameters eeded for this workitem.. Repeat above Order Lie Item iformatio for each umber rage --- Call process order ad get the order id xdp_iterfaces.process_order (l_order_header,l_order_parameter_list,l_order_lie_list,l_lie_param_list,l_order_id -- retured from process order,l_error_code,l_error_message ); -- Call Syc registratio API SYNC_REGISTER(pp_order_id => l_order_id,po_error_code => l_error_code,po_error_msg => l_error_message); IF lv_error_code = 0 THEN --- Commit Now commit; ELSE Do some error hadlig END IF END; F-12 Product Title/BookTitle as a Variable

253 Implemetig Number Portability Process Sychroizatio Order Submissio at the Door Service Provider side Algorithm to collate messages of differet umber rages ad submit as a sigle order Parse the commets 2 field to get the total messages, mesg cout, istallatio id. If (Commets 2 field idicates that its a part of a multiple umber rage) the Geerate a uique order umber from message elemets If ( etry does t exist i xdp_oe_order_headers for this Order umber) the Create a etry with this order o., provisioig_date = SYSDATE Ed if; // oe etry does t exist Create a Order Lie item with order o = < geerated order o> lie o = <message cout i the commets field> lie item ame = 'PORTING_ORDER_FROM_OPERATOR' provisioig_reqd_flag = 'Y' is_workitem_flag = 'Y' Call a procedure to derive each tag value pair i the message ad costruct it as a workitem parameter. For each message elemet Set order oe lie item param cout = loop cout Create order oe Lie item param ame = message tag ame Create order oe lie item param value = value Ed For; If (the total Lie item cout for this order o. i the order_oe_lies table = total messages i the commets2 field) the Call xdp_submit_oe_order() ad get the order id Call SYNC_REGISTER(orderid) ; ed if; commit; ed if;//(commets 2 field idicates that its a part of a multiple umber rage) Sychroize Request Fuctio Sychroise ( itemtype IN VARCHAR2,itemkey IN VARCHAR2,actid IN NUMBER,fucmode IN VARCHAR2,resultout OUT VARCHAR2 ) IS Implemetig Number Portability Process Sychroizatio F-13

254 Implemetig Number Portability Process Sychroizatio BEGIN Get the SYNC_REQD_FLAG parameter from the SDP Order IF (SYNC_REQD_ FLAG is false for this orderid or does ot exist) THEN complete_activity:sync; // retur here END IF; Get the SYNC_LABEL from the SDP Order Lie SELECT status,max_participats,parties_ot_i_syc FROM xp_syc_registratio WHERE syc_label = SYNC_LABEL FOR UPDATE OF status,max_participats,parties_ot_i_syc; IF a error is ecoutered THEN Publish a SYNC_ERR message (msg = SYNC_ERR, referece_id = SYNC_LABEL to_ char(activityid)) complete_activity:sync_err; // retur here END IF; IF 1 st Sychroise Request THEN Start the Sych Timer END IF; Decremet the parties_ot_syched IF (status is ot ACTIVE ) THEN Update the parties_ot_syched i XNP_SYNC_REGISTRATION with the decremeted value Publish a SYNC_ERR message (msg = SYNC_ERR, referece_id = SYNC_LABEL to_ char(activityid)) complete_activity:sync_err; // retur here ELSE // status is ACTIVE () IF (parties_ot_syched > 0) THEN Update the parties_ot_syched i XNP_SYNC_REGISTRATION with the decremeted value Subscribe for a SYNC message(mesg = SYNC, referece id = SYNC_LABEL to_ char(activityid)); Subscribe for a SYNC_ERR message(mesg = SYNC, referece id = SYNC_ LABEL to_char(activityid)); Subscribe for a SYNC_TIMER message(mesg = SYNC, referece id = SYNC_ F-14 Product Title/BookTitle as a Variable

255 Implemetig Number Portability Process Sychroizatio LABEL to_char(activityid)); ELSE Update the parties_ot_syched i XNP_SYNC_REGISTRATION with the max_ participats value Publish a SYNC message (msg = SYNC_ERR, referece_id = SYNC_LABEL to_ char(activityid)) complete_activity:sync; // Retur Here END IF END IF END // Ed of Sychroise Request Sychroize Registratio Fuctio SYNC_REGISTER ( pp_order_id IN NUMBER,po_error_code OUT NUMBER,po_error_msg OUT VARCHAR2 ) IS CURSOR lv_lie_item_cur (cv_order_id IN NUMBER) IS SELECT order_id - lie_item_ame syc_label,cout(*) rage_cout FROM xdp_order_lie_items WHERE order_id = cv_order_id GROUP BY order_id - lie_item_ame; -- Cursor to get all Lie Item ID s withi a Order -- based o the SYNC_LABEL CURSOR lv_lie_item_id_cur (cv_syc_label IN VARCHAR2) IS SELECT lie_item_id FROM xdp_order_lie_items WHERE order_id - lie_item_ame = cv_syc_label; BEGIN Add the SYNC_REQD_FLAG parameter to the SDP Order Set the SYNC_REQD_FLAG parameter = Y FOR each record IN lv_lie_item_cur LOOP Set the SYNC_LABEL parameter = SDP Order ID - Lie Item Name Set the RANGE_COUNT parameter = Nr of duplicate Lie Item Names FOR each record IN lv_lie_item_id_cur LOOP Add SYNC_LABEL as a lie item parameter Add RANGE_COUNT as a lie item parameter Implemetig Number Portability Process Sychroizatio F-15

256 Implemetig Number Portability Process Sychroizatio END LOOP Isert a row ito the XNP_SYNC_REGISTRATION table END LOOP END // Syc_Register fuctio Raise Sychroize Error Fuctio Raise_Syc_Error ( itemtype IN VARCHAR2,itemkey IN VARCHAR2,actid IN NUMBER,fucmode IN VARCHAR2,resultout OUT VARCHAR2 ) IS BEGIN Get the SYNC_LABEL parameter value for the SDP Order Lie Item Update the XNP_SYNC_REGISTRATION table to a status = ERROR Publish a SYNC_ERR message (msg = SYNC_ERR, referece_id = SYNC_LABEL to_ char(activityid)) complete_activity:success; END // Raise_Syc_Error fuctio; F-16 Product Title/BookTitle as a Variable

257 Implemetig Number Portability Process Sychroizatio Reset Sychroize Register Fuctio Reset_Syc_Register ( pp_syc_label IN VARCHAR2,po_error_code OUT NUMBER,po_error_msg OUT VARCHAR2 ) IS BEGIN Update the XNP_SYNC_REGISTRATION table to a status = ACTIVE Update the XNP_SYNC_REGISTRATION table to a parties_ot_i_syc = max_ participats END // Reset_Syc_Register fuctio;istallatio ad Upgrade Workflow Chages The followig chages are required to the SDP workflows Item Type Fuctio PL/SQL Procedure Call Result Type NP Stadard Sychroize Request XNP_ Message Type SYNC.SYNCHRONISE Raise Sychroize Error XNP_SYNC.RAISE_SYNC_ ERROR Success/Failure Item Type Fuctio PL/SQL Procedure Call Result Type NP Stadard Sychroize XNP_SYNC.SYNCHRONISE Message Type Request Raise Sychroize Error XNP_SYNC.RAISE_SYNC_ ERROR Success/Failure Implemetig Number Portability Process Sychroizatio F-17

258 : : Implemetig Number Portability Process Sychroizatio Seed Data The followig chages are required for the SDP Seed Data: Lookup Codes The followig Lookup Code/s are required Type Code Value Descriptio XNP_SYNC_REG_STATUS ACTIVE Sychroize Registratio is ACTIVE ERROR Sychroize Registratio is i ERROR User Display Message The followig User Display Message/s are required Name Applicatio Message Text XNP_SYNC_ REQUEST XNP Sychroize Request Error for &NUMRANGE $ : &ERROR_ TEXT Parameter Pool The followig seed parameter/s are required: Display Name Iteral Name Descriptio Rage Cout RANGE_COUNT Cout of the umber of Number Rages which are beig ported together Syc Label SYNC_LABEL Uique label used for sychroizatio Syc Required Flag SYNC_REQD_FLAG Flag to idicate if sychroizatio was required across lie items imessage Studio The followig message/s are required: F-18 Product Title/BookTitle as a Variable

259 Implemetig Number Portability Process Sychroizatio Message Code Type Queue Elemets Structure DataSource SYNC Evet Iteral Evet Queue SYNC_ERR Evet Iteral Evet Queue SYNC_ TIMER Timer Timer Queue SYNC_ LABEL SYNC_ LABEL Delay Iterval SYNC SYNC_ LABEL SYNC_ERR SYNC_ LABEL SYNC_ TIMER DELAY INTERVAL SELECT 0 delay, 100 iterval FROM dual; Processi g Logic NULL; XNP_ SYNC.PR OCESS_ SYNC_ ERR XNP_ SYNC.PR OCESS_ SYNC_ TIMER Implemetig Number Portability Process Sychroizatio F-19

260 Implemetig Number Portability Process Sychroizatio Packages The followig packages ad procedures are Required XNP_SYNC The XNP_SYNC package will cotai all procedures/fuctio to a sychroizatio request. PROCEDURE Sychroise ( itemtype IN VARCHAR2,itemkey IN VARCHAR2,actid IN NUMBER,fucmode IN VARCHAR2,resultout OUT VARCHAR2); DescriptioSycrhoise a Workflow Request PROCEDURE Syc_Register ( pp_order_id IN NUMBER,po_error_code OUT NUMBER,po_error_msg OUT VARCHAR2); DescriptioRegister a order for Sychroisatio PROCEDURE Raise_Syc_Error ( itemtype IN VARCHAR2,itemkey IN VARCHAR2,actid IN NUMBER,fucmode IN VARCHAR2,resultout OUT VARCHAR2); DescriptioSet the status of a Sychroisatio Request to ERROR PROCEDURE Reset_Syc_Register ( pp_syc_labelin VARCHAR2,po_error_codeOUT NUMBER,po_error_msgOUT VARCHAR2); DescriptioReset the Syc Registratio iformatio XDP_ENGINE The XDP_ENGINE is to be updated to iclude the followig procedures. request. PROCEDURE Reset_Syc_Registratio ( pp_syc_labelin VARCHAR2,po_error_codeOUT NUMBER,po_error_msgOUT VARCHAR2); DescriptioReset the Syc Registratio iformatio F-20 Product Title/BookTitle as a Variable

261 Implemetig Number Portability Process Sychroizatio XDP_OE_ORDER The XDP_OE_ORDER package provides a API iterface to create Order Etry order details i SDP. PROCEDURE Isert_Oe_Order ( p_oe_order_headerin xdp_types.oe_order_header,p_oe_order_parameter_listin xdp_types.oe_order_parameter_list,retur_codeout NUMBER,Error_DescriptioOUT VARCHAR2); DescriptioIserts ito the XDP_OE_ORDER_HEADERS ad XDP_OE_ORDER_PARAMETERS tables. PROCEDURE Isert_Oe_Order_Lie ( p_oe_order_liein xdp_types.oe_order_lie,p_oe_order_detail_listin xdp_types.or_order_lie_detail_list,retur_codeout NUMBER,Error_DescriptioOUT VARCHAR2); DescriptioIserts a Order Lie ad the associated Lie Parameters ito the XDP_OE_ORDER_LINES ad XDP_OE_ORDER_LINE_DETAILS tables. PROCEDURE Submit_OE_Order ( p_oe_order_numberin VARCHAR2,p_OE_Order_VersioIN VARCHAR2 DEFAULT NULL,SDP_Order_IDOUT NUMBER,retur_codeOUT NUMBER,Error_DescriptioOUT VARCHAR2); DescriptioSelects the Order iformatio fromthe XDP OE Order tables ad iserts ito the XDP Order Tables. Implemetig Number Portability Process Sychroizatio F-21

262 Implemetig Number Portability Process Sychroizatio Table List This should iclude a list of all ew ad revised tables associated with this desig Actual descriptios ad table additios ad chages will be addressed i the Detailed Desig. SYNC REGISTRATION Table F 7 XNP_SYNC_REGISTRATION Name Data type Null, Key Legth SYNC_LABEL VARCHAR2 No - UK 240 MAX_PARTICIPANTS NUMBER No PARTIES_NOT_IN_SYNC NUMBER No STATUS VARCHAR2 No 40 ORDER_ID NUMBER No SYNC_ID NUMBER No - PK Sedig Sychroized Notificatios - A Example The implemetatio at a customer ca use the Stadard Sychroizatio Activities provided by Oracle Number Portability. Two types of sychroizatio are idetified: Sychroizatio of otificatios This meas oe otificatio will be set for the Multiple Rage of x flows. The last flow will sed the otificatio. A aswer to this otificatio will also result i startig the other, waitig, flows. Geeral sychroized processig As a geeral rule, all the flows belogig to oe Portig Request will always have to take the same geeral directio. If a certai questio has to be aswered (e.g. Is the message validated?), this questio has to be aswered i the same way for all the flows. F-22 Product Title/BookTitle as a Variable

263 Implemetig Number Portability Process Sychroizatio Busiess Requiremet For some customers, oe portig request (cosistig of multiple rages) must always be see as oe logical etity. The fact that this i Oracle is implemeted usig multiple Workflow is a techical detail i which the user is ot iterested. This meas that all the commuicatio with the user eeds to be doe takig this ito accout. This commuicatio will primarily be doe usig Workflow otificatios. To make thigs acceptable for the user ad to hide the techical implemetatio oly ONE otificatio ca be set to the user for a Multiple Rage for a sigle questio. This meas that if 3 flows do ot eed maual validatio, but the 4 th oe does, the a otificatio eeds to be set to the user iformig him of the status of the 3 rages which are OK, but also iformig him of the fact that the 4 th rage eeds maual validatio. This otificatio ca look as follows: Dear User, Please perform maual validatio o the followig Portig Request: CRDC ID: <CRDC ID> Rage 1: <Number From> - <Number To> Validatio 1 : OK Validatio 2 : OK Reject Code: < > Rage 2: <Number From> - <Number To> Validatio 1 : OK Validatio 2 : OK Reject Code: < > Rage 3: <Number From> - <Number To> Validatio 1 : OK Validatio 2 : OK Reject Code: < > Rage 4: <Number From> - <Number To> Validatio 1 : OK Validatio 2 : NOK Maual Itervetio eeded Reject Code: < > Due to a limitatio of the Workflow system, the reject codes will have to be etered o a separate page (usig a URL), but all the iformatio eeds to be preset o the otificatio itself. This ca be doe usig PL/SQL Documets. Implemetig Number Portability Process Sychroizatio F-23

264 Implemetig Number Portability Process Sychroizatio Stadard Workflow Activities The followig item type attribute eeds to be preset i the Workflow: XXBG: The Documet ID Iteral ame: XXBGDOCID. This attribute ca remai empty at the start of your workflow. You ca copy this attributes over from the XXBG: Library of Sychroizatio Fuctios item type. The followig activities are used: Questio.ico Update Syc Couter ad Check if Last Workflow This activity determies whether the flow to arrive at this poit is the last flow, or oe of the other flows. This activity has two possible results: Last: The flow to arrive is the last flow Others: The flow to arrive is oe of the others This activity ca be foud i the SDP Stadard item type ad does ot eed to be chaged before it ca be used. Warig: Do NOT copy this activity to your item type. Draggig it to your flow is sufficiet F-24 Product Title/BookTitle as a Variable

265 Implemetig Number Portability Process Sychroizatio Timer.ico Process Sychroize if Last Workflow or Wait This activity lets the flows wait, util the last flow has set a otificatio, ad received a respose. The respose will kick off this activity with the same result as the respose to the otificatio. This activity ca be foud i the SDP Stadard item type. It eeds to be copied over to your item type, ad the result type eeds to be chaged to be the same as the otificatio which will be set. Flxasg.ico XXBG: Set the Documet ID If your otificatio has to iclude data about all the rages i the Multiple DNR Portig Request, the you have to iclude this activity just before sedig your otificatio. Please ote that practically all the otificatios you sed have to iclude iformatio about multiple DNR s, so you must have very good reasos ot to iclude this fuctio. This fuctio makes sure that you kow for which DNR s to iclude the iformatio. Ntf_urg.ico <Your Notificatio> This otificatio is set oce for the etire Portig Request, ad should therefore cotai iformatio cocerig the etire Request (see example above). This iformatio ca be show to the user usig PL/SQL documets. This otificatio eeds to have the same possible results as the waitig activity. Implemetig Number Portability Process Sychroizatio F-25

266 Implemetig Number Portability Process Sychroizatio You ca use ay otificatio you choose to use, the post-otificatio fuctio eeds to be specified as XNP_WF_SYNC.SYNCNOTIF. The message you make has to use PL/SQL Documets. The value of your PL/SQL Documet eeds to be exactly as follows: plsql:<ame of your procedure>/&xxbgdocid The PL/SQL documet used i the example uses the followig code. It uses the fuctioality offered by the XXBG_SYNC_PKG package. The example ca be used as a template. PROCEDURE PLSQLDOC ( documet_id i varchar2, display_type i varchar2, documet i out varchar2, documet_type i out varchar2 ) IS v_orderid VARCHAR2(100); v_wi_istace NUMBER; BEGIN -- First get the OrderID XXBG_SYNC_PKG.PARSEDOCID( documet_id, v_orderid ); -- Make the message FOR Flows_Rec IN XXBG_SYNC_PKG.SYNCED_FLOWS(v_OrderID) LOOP v_wi_istace := Flows_Rec.WORKITEM_INSTANCE_ID; XXBG_SYNC_PKG.PRINTLINE(display_type, documet, ' Startig Number: ' XDP_ENGINE.GET_WORKITEM_PARAM_ VALUE(v_WI_Istace, 'STARTING_NUMBER')); XXBG_SYNC_PKG.PRINTLINE(display_type, documet, ' Edig Number : ' F-26 Product Title/BookTitle as a Variable

267 Implemetig Number Portability Process Sychroizatio XDP_ENGINE.GET_WORKITEM_PARAM_ VALUE(v_WI_Istace, ENDING_NUMBER )); XXBG_SYNC_PKG.PRINTLINE(display_type, documet); END LOOP; -- That is it XXBG_SYNC_PKG.PRINTLINE(display_type, documet); XXBG_SYNC_PKG.PRINTLINE(display_type, documet, That is it... ); END; Oly oe brach (the <default> brach) is allowed to leave from your otificatio. This brach eeds to go the Process Sychroize if Last Workflow or Wait activity, which will the proceed (please ote that your otificatio ad your Process Sychroize if Last Workflow or Wait activity eed to have the same Result Type). Example Flow A example flow ca be foud i Appedix A. This is a otificatio which is actually used i the XXBG: Door Iitiatio ad Preparatio Phase item type. Sychroized Processig Busiess Requiremet If some automatic validatio, cosistecy checks or geeral questios take place i a Portig Request, the all the flows i the same Portig Request always eed to give the same aswer to the questios to esure sychroizatio. For example: If automatic validatio of x topics eed to take place, the we will defie x item type attributes i the workflow. These attributes will the be filled up with the result of the validatios. This doe for all the flows separately. At the ed of this validatio, oe has to take all the results ito accout to come to a fial result. This will have to be a sychroized result, because we will have to wait for the last flow to be able to come to a coclusio. Implemetig Number Portability Process Sychroizatio F-27

268 Implemetig Number Portability Process Sychroizatio Stadard Workflow Activities The followig activities are used: Questio.ico Update Syc Couter ad Check if Last Workflow This activity determies whether the flow to arrive at this poit is the last flow, or oe of the other flows. This activity has two possible results: Last: The flow to arrive is the last flow Others: The flow to arrive is oe of the others This activity ca be foud i the SDP Stadard item type ad does ot eed to be chaged before it ca be used. Warig: Do NOT copy this activity to your item type. Draggig it to your flow is sufficiet Timer.ico Process Sychroize if Last Workflow or Wait This activity lets the flows wait, util the last flow processes your process which determies the global result for all the flows. This activity ca be foud i the SDP Stadard item type. It eeds to be copied over to your item type, ad the result type eeds to be chaged to be the same as the possible results your process will geerate. F-28 Product Title/BookTitle as a Variable

269 Implemetig Number Portability Process Sychroizatio Fuctio.ico <Your Process> This is a fuctio you eed to write. This fuctio eeds to determie the result which all the flows are to follow. Below you ca fid a template you must use. This template ca be foud i the XXBG_SYNC_PKG package. The parts you have to chage are put i bold: PROCEDURE SYNC ( itemtype i varchar2, itemkey i varchar2, actid i umber, fucmode i varchar2, result out varchar2 ) IS v_orderid NUMBER; v_globalresult VARCHAR2(100); -- Assig a DefaultValue to this Variable BEGIN IF fucmode = RUN THEN -- Get the OrderID associated with this Order v_orderid := WF_ENGINE.GetItemAttrNumber( itemtype, itemkey, ORDER_ ID ); -- Start Loopig through the Waitig Flows FOR All_Flows_Rec IN XXBG_SYNC_PKG.SYNCED_FLOWS( v_orderid ) LOOP -- ADD YOUR CUSTOM CODE HERUNDER to Determie the Result You have access to the etire XDP_ORDER_ DETAILS_V view -- e.g. : WORKITEM_INSTANCE_ID -- WF_ITEM_TYPE -- WF_ITEM_KEY v_globalresult := GO ; -- ADD YOUR CUSTOM CODE ABOVE to Determie the Result... Implemetig Number Portability Process Sychroizatio F-29