Initial file format NRDB Validation.doc. Revision

Transkript

1 ocument information: Document title Document archive number File name and storage location Description NRDB Validation Initial file format NRDB Validation.doc NRDB Validation MS Word 2000 Current revision 1.0 Revision Released Author(s) KOB/ØH Pre-release checked date Pre-release checked by Approved from vendor date Approved from vendor by Approved from customer date Approved from customer by GB Revision history: Revision 1.00 : Initial version KOB Systor Trondheim as / KOB/ØH / Page 1 of 10

2 Table of contents 1 INTRODUCTION DOCUMENT DESCRIPTION TARGET AUDIENCE REFERENCE DOCUMENTATION ABBREVIATIONS PROCEDURE INTERFACE VALIDATION STORED PROCEDURE: SSP_USER_LOGIN STORED PROCEDURE: SSP_LOGOUT STORED PROCEDURE: SSP_MSG_GET STORED PROCEDURE: SSP_MSG_OUT STORED PROCEDURE: SSP_MSG_IN STORED PROCEDURE SSP_NRDB_REFERENCES_GET STORED PROCEDURE: SSP_PROVIDER_GET WEB INTERFACE VALIDATION USER LOGIN PARAMETER VALIDATION MANDATORY CHECK GENERAL VALIDATION... 9 Systor Trondheim as / KOB/ØH / Page 2 of 10

3 1 Introduction 1.1 Document description This document describes the validation rules maintained by NRDB. The NRDB system provides 2 interfaces; a stored procedure call interface and a web-based interface. All interfaces are accessible at the corresponding service provider's local NRDB node. At the internet node, only the web-based interface is available. Initially, no validation was defined for NRDB. It was decided to delegate the responsibility to each participating provider. But the web-based interface is an end-user application, and is now also available via the Internet. It was decided to implement some i ntuitively necessary validation rules for the webbased interface, to avoid specific error situations and messaging overhead. The procedure interface has also been subject to validation, realising that some degree of validation is necessary. Several validation rules has already been implemented. A complete revision of NRDB validation is planned. An important point is now to support equal validation for both procedure interface and web-based interface. This document will be revised when NRDB validation rules are revised. Currently implemented validation rules for the procedure interface and web-based interface are described by this document (module = porting; Videresalg isn t included). 1.2 Target audience This document is targeted for service providers that must integrate their backoffice systems to the NRDB system. The document is a supplement to the Interface Specification [1]. 1.3 Reference documentation Ref.ID Doc. No. Description Version Interfaces Specification - NRDB 10.01/ Abbreviations Abbreviation NRDB Description National Reference DataBase Systor Trondheim as / KOB/ØH / Page 3 of 10

4 2 Procedure interface validation This section describes currently implemented validation rules that applies to the stored procedure interface of NRDB [1]. Specific validation occurs for the specific stored procedures. See also [1] for a description of each stored procedure. 2.1 Stored procedure: ssp_user_login This procedure is invoked when a user (service provider) logs in to NRDB. A user must be logged in (have a valid session ID) to perform any action against NRDB. Object Criteria Code Error message (Norwegian) Username must exist 400 Ugyldig Login attempts The number of failed login attempts must not exceed a specific value 402 Kontoen er sperret på grunn av for mange feilaktige The password must belong to a correct username 401 Ugyldig passord 2.2 Stored procedure: ssp_logout This procedure is invoked to log out from NRDB. Object Criteria Code Error message (Norwegian) Usersession must exist 406 Brukersesjonen eksisterer ikke : <session_id> User session must be active (user logged in and session not expired) 443 Brukeren er allerede utlogget av sesjon <session_id> 2.3 Stored procedure: ssp_msg_get This procedure is invoked to get a list of currently unhandled NRDB messages (incoming) for the actual service provider. Object Criteria Code Error message (Norwegian) Session (user) must belong to a valid service provider 4 Current user does not have a valid service provider id The session must not be terminated 4 Brukersesjon <session_id> er allerede terminert. Logg inn på nytt Idle time Idle time must not exceed session 4 Brukersesjon <session_id> er Authorisation timeout The service provider for the current user must be granted access to module = portering. utløpt. Logg inn på nytt 4 Autorisasjon mangler for å benyttte denne funksjonaliteten. Ta kontakt med NRDB eller Systor 2.4 Stored procedure: ssp_msg_out This procedure is invoked to retrieve a specific NRDB message. Systor Trondheim as / KOB/ØH / Page 4 of 10

5 Object Criteria Code Error message (Norwegian) Usersession must exist 4 Brukersesjonen <session_id> eksisterer ikke! Idle time Idle time must not exceed session timeout 4 Brukersesjon <session_id> er utløpt. Logg inn på nytt The session must not be terminated 4 Brukersesjon <session_id> er allerede terminert. Logg The service provider for the current user must be granted access to module portering. på nytt 4 Autorisasjon mangler for å benyttte denne funksjonaliteten. Ta kontakt med NRDB eller Systor Nrdbmsg_id must exist 4 A message with identity <nrdbmsg_id> does not exist The actual message must have the same type as parameter nrdbmsgtype_id 4 Message <message_id> is of message type <nrdbmsgtype_id> and not of <nrdbmsgtype_id> 2.5 Stored procedure: ssp_msg_in This procedure is invoked to send a new NRDB message via NRDB. Object Criteria Code Error message (Norwegian) Usersession must exist 4 Brukersesjonen <session_id> eksisterer ikke! Idle time Idle time must not exceed 4 Brukersesjon @ip_subscr_type session timeout The session must not be terminated The service provider for the current user must be granted access to module portering. Sender of the message must belong to the same provider as the login-user Recipient of the message must have a valid providerid Subscriptiontype must be valid er utløpt. Logg inn på nytt 4 Brukersesjon <session_id> er allerede terminert. Logg inn på nytt 4 Autorisasjon mangler for å benyttte denne funksjonaliteten. Ta kontakt med NRDB eller Systor 4 Sender identitet stemmer ikke med det som er angitt på brukeren. Det må være identisk. 4 <recipient_id> er ugyldig service provider 4 <subscr_type> er ikke gyldig abonnent type. Gyldige verdier er E, T, CustomerID must be valid 4 Ugyldig kunde ID <customer_id>. Format : YYYYMMDD Messageflow NP_FIVE (commando message) must be sent before porting datetime If directionnumber <> null, it must be a numeric value A valid commando message must be sent in a case 4 NP_FIVE (stoppmelding) kan ikke sendes fordi porteringstidspunkt har passert 4 Ugyldig format i parameter directionnumber_out 4 Brudd i meldingssekvens. Forsøkt sendt melding er et Systor Trondheim as / KOB/ØH / Page 5 of 10

6 Messageflow / add_x / add_x / add_x and -add_x and s If nrdbmsgtype_id is not of type NP_FORE, NP_BEST, NP_OPPPS or 5_IVER, a caseidentificator must be given. Telephonenumber must be valid (numeric of length 3, 5 or 8 characters) Telephonenumber must exist in the numberplan Telephonenumber must belong to defined provider and set to active in the numberplan The telephonenumbers must have the same dsp All the telephonenumbers in one nrdbcase must either have status ported / terminated or videresolgt For messagetype NP_OPPS, the number must be ported (not videresolgt) If dsp/ odsp <>null, the dsp and odsp must be the same as in NRDB s portingtable / numberplan DSP and odsp can be set to null RSP must be different from responsible service provider for the number RSP must have the same providerid as the user who is trying to send the message. In a NP_OPPS and NP_ANOPS message, the RPSP must own the telephonenumbers in the message In a NP_OPPS and NP_ANOPS message, the rpsp must have the same providerid as the user who is trying to send the message In a NP_IVER message the parameter port_ended can be set to null brudd på meldingssekvensen i denne saken. 4 Case identifikator er obligatorisk 4 Ugyldig telefonnummer 4 Telefonnummeret <telephonenumber> finnes ikke. 4 Telefonnummeret <telephonenumber> er ikke tildelt noen operatører. 4 Forskjellig dsp for numrene i samme melding 4 Alle telefonnumrene må være portert eller videresolgt innenfor en porteringssak 4 Kan ikke kjøre oppsigelse på et nummer som er videresolgt 4 Feil dsp eller odsp angitt. Rett dsp er <dsp> og odsp er <odsp> 0 Dsp eller odsp ikke angitt. Rett dsp er <dsp> og odsp er <odsp> 4 Telefonnumrene tilhører allerede mottakende operatør. 4 Din tilbyderkode og angitt ansvarlig tilbyderkode stemmer ikke overens. 4 Feil ansvarlig tilbyder <rpsp> angitt. Riktig ansvarlig tilbyder er <rpsp>. 4 Operatør <providerid> er ansvarlig operatør for disse telefonnumrene. 0 Ingen port_ended angitt. Rett port_ended er <port_ended> 2.6 Stored procedure ssp_nrdb_references_get This procedure is invoked to retrieve a list of number references (and information regarding the actual porting), according to specific criteria. Systor Trondheim as / KOB/ØH / Page 6 of 10

7 No validation applies. 2.7 Stored procedure: ssp_provider_get This procedure is invoked to retrieve a list of provider IDs for members of NRDB. No validation applies. Systor Trondheim as / KOB/ØH / Page 7 of 10

8 3 Web interface validation This section describes currently implemented validation rules that applies to the web interface of NRDB [1]. Temporarily, the section describes validation only for porting. Videresalg Telefoni (VT) is not included. 3.1 User login A user must be logged in (have a valid session ID) to perform any action against NRDB. Object Criteria Error message (Norwegian) User name Username must exist Ugyldig brukernavn Login attempts The number of failed login attempts must not exceed a specific value Kontoen er sperret på grunn av for mange feilaktige pålogginger Password The password must belong to a correct username Ugyldig passord 3.2 validation When the service provider are sending a message to NRDB, some parametervalues will be validated. Object Criteria Error message (Norwegian) CustomerID CustomerID must be valid Ugyldig kunde ID <customerid>. Format : YYYYMMDD eller XXXXXXXXX Subscriptiontype Subscriptiontype must be valid Ugyldig abonnementstype <subscriptiontype>. Format : {E,T,S} Subscriptiontype Subscriptiontype must be valid For abonnementstype E (enkelt nummer) kan en ikke benytte tilleggsnummer. Subscriptiontype Subscriptiontype must be valid For abonnementstype T eller S må man benytte minst ett tileggsnummer. Telephonenumber Telephonenumber must be valid Feil format i angitt nummerserie <numberserie>. Kan ikke inneholde mellomrom Telephonenumber Telephonenumber Telephonenumber Port datetime Telephonenumber must be valid (Telephonenumber_add must not ending with a, or - ) Telephonenumberseries must be valid Telephonenumberseries must be valid Port datetime must be set to a time in the future. Ugyldig format i parameter <telephonenumber> Ved telefonnummerserier må fra nummer være mindre enn til nummer. Det må være likt antall siffer i fra og til telefonnummeret i en nummerserie. Ugyldig porteringstidspunkt. Porteringstidspunktet må ligge frem i tid. Ugyldig format i parameter <directionnumber_out> Directionnumber_out If directionnumber_out has got a value, it must be a numeric value ErrorCode Errorcode must be valid, ref[1] Ugyldig feilkode <error code> Systor Trondheim as / KOB/ØH / Page 8 of 10

9 3.3 Mandatory check In commandomessages, such as NP_BEST and NP_ANBES, and errormessages, such as NP_FBES, a mandatory check of parameters is implemented. For responsemessages, other than errormessages, and ack-messages, the mandatory check is disabled. (Reason : web-users must have the opportunity to answer a commandomessage that containing errors and is sent from the procedure interface) The tables below are showing the parameters pr messagetype which got a mandatory check. The messagetypes which is not in the table, haven t got this validation. If some of the marked parameters are missing, NRDB returns the errormessage : Obligatorisk parameter <parameter> mangler. \ Msgtype FORE BEST ENDR IVER OPPS ANBES ANOPS FBES Auth_ref X X X X X X X Customer_ID X X X X X X X X Customer_name X X X X X X X X Subscr_type X X X X X X X X Telephonenumber X X X X X X X X main Contact_name X Contact_telephone X Contact_ X Port_datetime X X X X X X Directionnumber X X Error_code X Error_field X \ Msgtype FEND FIVE FOPS FFOR FANB FANO 5_IVER 5_FIVE Auth_ref X X X X X X Customer_ID X X X X X X X X Customer_name X X X X X X X X Subscr_type X X X X X X X X Telephonenumber X X X X X X X X main Contact_name X Contact_telephone X Contact_ X Port_datetime X X X X X X Directionnumber X X Error_code X X X X X X X Error_field X X X X X X X In the web interface many of the parameters are automatically set by NRDB. Some of these parameters are copied from the belonging parentmessage into the response or follow-up message (telephonenumber,auth_ref, rsp,dsp, odsp etc). Other parameters will be changed from the original message (sequencenumber), or added /removed (port_possible, order_cancelled, order_stopped, rsp_ready etc.) Some of the mandary parameters aren t even editable in the web interface. Still there is validation. In these situations, the service provider must contact Systor to be able to send the message. 3.4 General validation The table below shows validation concerning messageflow and logic that is implemented for NRDB Web. Object Criteria Error message (Norwegian) Telephonenumber The telephonenumbers must have Forskjellig dsp for nummer i Systor Trondheim as / KOB/ØH / Page 9 of 10

10 the same dsp samme melding. Telephonenumber Telephonenumber must belong to defined provider and set to active in the numberplan Telefonnummeret <telephonenumber> er ikke tildelt noen operatør Telephonenumber All the telephonenumbers in one nrdbcase must either have status ported / terminated or videresolgt Alle telefonnumre må være portert eller videresolgt innenfor en porteringssak. Telephonenumber For messagetype NP_OPPS, the number must be ported (not videresolgt) Kan ikke kjøre oppsigelse på telefonnummer som er videresolgt Telephonenumber RSP must be different from responsible service provider for Telefonnummeret tilhører allerede mottakende operatør. the number Rpsp In a NP_OPPS and NP_ANOPS message, the RPSP must own the telephonenumbers in the message Feil ansvarlig tilbyder angitt <rpsp>. Riktig ansvarlig tilbyder er <rpsp> Dsp / Odsp Dsp and odsp must be valid. Feil dsp eller odsp angitt. Rett dsp er <dsp> og odsp er <odsp> Port datetime Messageflow NP_FIVE (commando message) must be sent before porting datetime A message must be valid in the messageflow. NP_FIVE (stoppmelding) kan ikke sendes fordi porteringstidspunkt har passert. Det kan ikke opprettes nye meldinger i denne saken. Systor Trondheim as / KOB/ØH / Page 10 of 10