MWD Komunikat dla usług komrcjnch Wrsja dokumntu 4.3-2-1.6 Status Wdrożon Data wdrożnia 3Q 2014
Spis trści 1 Dokumnt powiązan... 15 2 Słownik pojęć... 15 3 Wstęp... 15 3.1 Zasad numrowania dokumntu MWDK... 15 4 Zasad komunikacji... 16 4.1 Mapowani danch biznsowch na komunikat tchniczn... 16 4.2 Schmat komunikacji... 16 4.3 Kanał komunikacjn... 19 4.3.1 Format komunikatu... 19 4.4 Kanał WbSrvic... 20 4.4.1 Dan konfiguracjn kanału... 20 4.4.2 Spcfikacja tchniczna kanału... 20 4.4.3 Sposób przsłania komunikatów w kanal... 21 4.4.4 Zasad bzpiczństwa przsłu danch w kanal... 23 4.4.5 Przsłani plików w kanal WbSrvic... 23 4.4.6 Obsługa trbu RELAY w kanal WbSrvic... 25 4.5 Kanał WWW... 26 4.5.1 Dan konfiguracjn kanału... 26 4.5.2 Spcfikacja postaci pliku z komunikatami... 26 4.5.3 Podgląd historii komunikacji... 27 5 Tabla mapowania komunikatów na rozdział MWDP... 27 6 Tp podstawow... 35 6.1 BASKET-ID... 35 6.2 BOOLEAN... 35 6.3 CHAR_10... 35 6.4 CHAR_100... 35 MWD Komunikat dla usług komrcjnch wrsja 4.3-2-1.6 2
6.5 CHAR_1024... 36 6.6 CHAR_12... 36 6.7 CHAR_12_FIXED... 36 6.8 CHAR_20... 36 6.9 CHAR_200... 36 6.10 CHAR_2048... 36 6.11 CHAR_24... 36 6.12 CHAR_256... 36 6.13 CHAR_30... 37 6.14 CHAR_50... 37 6.15 CHAR_512... 37 6.16 CHAR_5_FIXED... 37 6.17 CHAR_64... 37 6.18 CHAR_6_FIXED... 37 6.19 CHAR_7... 37 6.20 CHAR_8... 37 6.21 DATE... 37 6.22 DATETIME... 38 6.23 DECIMAL_12_2... 38 6.24 FILE-ID_TYPE... 38 6.25 FLOAT_5_3... 38 6.26 FLOAT_7_3... 38 6.27 ID... 38 6.28 INT_1... 38 6.29 INT_10... 39 6.30 INT_11... 39 6.31 INT_12... 39 MWD Komunikat dla usług komrcjnch wrsja 4.3-2-1.6 3
6.32 INT_15... 39 6.33 INT_1_FIXED... 39 6.34 INT_2... 39 6.35 INT_24... 39 6.36 INT_2_FIXED... 39 6.37 INT_3... 40 6.38 INT_4... 40 6.39 INT_4_FIXED... 40 6.40 INT_5... 40 6.41 INT_7... 40 6.42 INT_9... 40 6.43 INT_9_POS... 40 6.44 IP... 40 6.45 MSN-QUANTITY... 41 6.46 NDS... 41 6.47 OA... 41 6.48 PHONE-NUMBER... 41 6.49 POSTAL-CODE... 41 6.50 RN... 41 6.51 SERVICE-ID... 41 6.52 SWAREF... 42 7 Tchniczna spcfikacja rkordów... 42 7.1 MSG-HEADER... 42 7.2 ADDRESS... 43 7.3 LOC-ADDRESS... 44 7.4 CONTACT-DATA... 44 7.5 CUSTOMER-CONTACT-DATA... 45 MWD Komunikat dla usług komrcjnch wrsja 4.3-2-1.6 4
7.6 CUSTOMER-NAME... 45 7.7 PERSON... 46 7.8 DOCUMENT... 46 7.9 ATTACHMENT... 46 8 Komunikat... 46 8.1 ABORT... 47 8.2 ACK... 48 8.3 ATTACHMENTS... 48 8.4 TECHNICAL-PROOF... 49 8.5 TECHNICAL-PROOF-STATUS-NFV... 51 8.6 TECHNICAL-PROOF-STATUS... 52 8.7 ASSISTANCE-ORDER... 54 8.8 ASSISTANCE-ORDER-STATUS-FV... 56 8.9 CANCEL-ASSISTANCE-ORDER... 57 8.10 CANCEL-ASSISTANCE-ORDER-STATUS... 58 8.11 ASSISTANCE-ORDER-CHANGE-DATE... 59 8.12 ASSISTANCE-ORDER-CHANGE-DATE-STATUS... 60 8.13 ASSISTANCE-ORDER-TP-CHANGE-DATE... 62 8.14 ASSISTANCE-ORDER-STATUS... 63 8.15 PAYMENT-START... 66 8.16 PAYMENT-STOP... 66 8.17 COMPLAINT-NFV... 67 8.18 COMPLAINT-NFV-STATUS... 68 8.19 FAULT-SERVICE... 70 8.20 FAULT-SERVICE-STATUS-FV... 74 8.21 FAULT-SERVICE-STATUS... 75 8.22 APPOINTMENT-DATE-CHANGE... 79 MWD Komunikat dla usług komrcjnch wrsja 4.3-2-1.6 5
8.23 FAULT-SERVICE-STATUS-RESTORE... 79 8.24 FAULT-SERVICE-STATUS-ACC... 82 8.25 FAULT-PRIORITY-DATABASE-UPDATE... 82 8.26 FAULT-PRIORITY-DATABASE-UPDATE-NFV... 83 8.27 FAULT-PRIORITY-DATABASE-STATUS... 84 8.28 MASS-IMPORT... 85 8.29 MASS-IMPORT-STATUS... 86 8.30 COMPLAINT... 87 8.31 COMPLAINT-QUEST... 88 8.32 COMPLAINT-ANSWER... 89 8.33 COMPLAINT-ESCALATION... 89 8.34 COMPLAINT-STATUS... 90 8.35 INTERVENTION... 92 8.36 INTERVENTION-STATUS... 95 8.37 ORDER-MIGRATION... 98 8.38 ORDER-STATUS-NFV... 109 8.39 ORDER-MIGRATION-ACC-TO-DONOR... 110 8.40 ORDER-MIGRATION-ACC-TO-HOST... 111 8.41 ORDER-VERIFICATION-FROM-DONOR... 113 8.42 ORDER-VERIFICATION-FROM-HOST... 114 8.43 ORDER-MIGRATION-REJECTION-TO-DONOR... 115 8.44 ORDER-MIGRATION-REJECTION... 117 8.45 ORDER-MIGRATION-REJECTION-TO-HOST... 118 8.46 ORDER-MIGRATION-STATUS-PTV... 120 8.47 ORDER-MIGRATION-STATUS-PTV-TO-HOST... 121 8.48 ORDER-MIGRATION-STATUS-PTV-TO-DONOR... 122 8.49 ORDER-MIGRATION-INS-ACTIVE-STATUS-NTV... 122 MWD Komunikat dla usług komrcjnch wrsja 4.3-2-1.6 6
8.50 ORDER-MIGRATION-INS-ACTIVE-STATUS-NTV-TO-DONOR... 125 8.51 ORDER-MIGRATION-INS-ACTIVE-STATUS-NTV-TO-HOST... 126 8.52 ORDER-STATUS-ANNEX... 127 8.53 ORDER-LOC-STATUS-ANNEX... 129 8.54 ORDER-ESTIMATION... 130 8.55 ORDER-ESTIMATION-ACC... 131 8.56 ORDER-INVEST... 131 8.57 ORDER-INVEST-ACC... 132 8.58 ORDER-NEW-REALIZATION-DATE... 133 8.59 ORDER-NEW-REALIZATION-DATE-NEG-TO-HOST... 134 8.60 ORDER-NEW-REALIZATION-DATE-NEG-TO-DONOR... 135 8.61 ORDER-NEW-REALIZATION-DATE-NEG... 136 8.62 ORDER-NEW-REALIZATION-DATE-ACC-TO-HOST... 138 8.63 ORDER-NEW-REALIZATION-DATE-ACC-TO-DONOR... 138 8.64 ORDER-NEW-REALIZATION-DATE-ACC... 139 8.65 ORDER-BUILD-END... 140 8.66 ORDER-REALIZATION-DATE... 141 8.67 ORDER-REALIZATION-DATE-TO-HOST... 142 8.68 ORDER-REALIZATION-DATE-TO-DONOR... 143 8.69 ORDER-MIGRATION-INS-WITH-PARAMS... 144 8.70 ORDER-RTN... 153 8.71 ORDER-RTN-TO-DONOR... 154 8.72 ORDER-RTN-TO-HOST... 155 8.73 ORDER-SUPERIORFORCE... 156 8.74 ORDER-SUPERIORFORCE-TO-DONOR... 156 8.75 ORDER-SUPERIORFORCE-TO-HOST... 157 8.76 ORDER-RTN-END... 157 MWD Komunikat dla usług komrcjnch wrsja 4.3-2-1.6 7
8.77 ORDER-RTN-END-TO-DONOR... 158 8.78 ORDER-RTN-END-TO-HOST... 159 8.79 ORDER-REGISTRATION-POS... 160 8.80 ORDER-REGISTRATION-NEG... 160 8.81 ORDER-REGISTRATION-DEACT... 161 8.82 ORDER-BSA-TYPE-MOD... 162 8.83 ORDER-BSA-TYPE-MOD-WITH-PARAMS... 164 8.84 ORDER-MOD-STATUS-NFV... 166 8.85 ORDER-MOD-STATUS-PTV... 167 8.86 ORDER-BSA-MOD-STATUS-NTV... 168 8.87 ORDER-BSA-MOD-NEW-REALIZATION-DATE-ACC... 171 8.88 ORDER-BSA-OPTION-MOD... 172 8.89 ORDER-LLU-MOD... 174 8.90 ORDER-LLU-MOD-WITH-PARAMS... 177 8.91 ORDER-CORR-CABLE-MOD... 179 8.92 ORDER-CORR-CABLE-MOD-FV... 180 8.93 ORDER-CORR-CABLE-MOD-STATUS... 181 8.94 ORDER-VPVC-MOD... 182 8.95 ORDER-VPVC-MOD-STATUS... 184 8.96 ORDER-LLU-LPPA... 185 8.97 ORDER-LLU-LPPA-STATUS-NTV... 187 8.98 ORDER-LLU-LPPA-WITH-PARAMS... 187 8.99 ORDER-INS-ACTIVE... 189 8.100 ORDER-INS-ACTIVE-STATUS-PTV... 197 8.101 ORDER-INS-NEW-REALIZATION-DATE-ACC... 199 8.102 ORDER-INS-INACTIVE... 201 8.103 ORDER-INS-INACTIVE-STATUS-NFV... 210 MWD Komunikat dla usług komrcjnch wrsja 4.3-2-1.6 8
8.104 ORDER-INS-INACTIVE-STATUS-PTV... 211 8.105 ORDER-INS-INACTIVE-STATUS-NTV... 213 8.106 LOG-QUERY... 216 8.107 LOG-QUERY-RES... 217 8.108 CANCEL-ORDER... 218 8.109 CANCEL-ORDER-NEG... 218 8.110 CANCEL-ORDER-POS... 219 8.111 RESIGN... 220 8.112 RESIGN-NFV... 221 8.113 ORDER-RMV-REALIZATION-DATE... 222 8.114 RESIGN-END... 223 8.115 RESIGN-EQUIPMENT... 224 8.116 ORDER-WLR-PRESELECTION... 224 8.117 ORDER-WLR-STATUS-NFV... 226 8.118 ORDER-WLR-PRESELECTION-REALIZATION-DATE... 227 8.119 ORDER-WLR-SUSPEND... 229 8.120 ORDER-WLR-SUSPEND-REALIZATION-DATE... 231 8.121 ORDER-WLR-VAS... 232 8.122 ORDER-WLR-VAS-REALIZATION-STATUS... 234 8.123 ORDER-WLR-NUMBER... 235 8.124 ORDER-WLR-NUMBER-TV... 238 8.125 ORDER-WLR-NUMBER-REALIZATION-STATUS... 239 8.126 CESSION... 241 8.127 CESSION-ACC-TO-DONOR... 243 8.128 CESSION-FV... 244 8.129 CESSION-STATUS... 245 8.130 CESSION-NFV-FROM-RECIPIENT... 246 MWD Komunikat dla usług komrcjnch wrsja 4.3-2-1.6 9
8.131 SERVICE-QUERY... 247 8.132 SERVICE-QUERY-RES... 248 8.133 ORDER-LOCATION-CHG... 250 8.134 ORDER-LOCATION-CHG-STATUS-PTV... 255 8.135 ORDER-LOCATION-CHG-STATUS-NTV... 257 8.136 ORDER-LOCATION-CHG-REALIZATION-DATE... 260 8.137 ORDER-WLR-ADDRMV... 260 8.138 ORDER-WLR-ADDRMV-STATUS-PTV... 264 8.139 ORDER-WLR-ADDRMV-STATUS-NTV... 266 8.140 ORDER-WLR-ADDRMV-REALIZATION-DATE... 267 8.141 ORDER-WLR-ADDRMV-WITH-PARAMS... 268 8.142 CUSTOMER-CLAIM... 272 8.143 ORDER-WLR-ADDRMV-CHANNEL... 275 8.144 ORDER-WLR-ADD-PBX... 276 8.145 ORDER-WLR-MOD-PBX... 277 8.146 ORDER-WLR-RMV-PBX... 279 8.147 ORDER-WLR-ADD-PBXDDI... 280 8.148 ACCEPTANCE-PROTOCOL... 281 8.149 ACCEPTANCE-PROTOCOL-REMARKS... 282 8.150 ORDER-BCHANNELS-ADDRMV-PTV... 282 8.151 ORDER-BCHANNELS-ACC... 283 8.152 ORDER-PBX-SLA-TV... 284 8.153 ORDER-WLR-INSTALL-LINE... 285 8.154 ORDER-WLR-REINSTALL-LINE... 287 8.155 ORDER-WLR-ADD-PBXDDI-STATUS... 288 8.156 ORDER-WLR-MOD-PBXDDI... 291 8.157 ORDER-WLR-MOD-SLA... 295 MWD Komunikat dla usług komrcjnch wrsja 4.3-2-1.6 10
8.158 ORDER-WLR-MOD-SLA-STATUS... 297 8.159 ORDER-PBX-MOD-STATUS-PTV... 298 8.160 ORDER-WLR-PBXDDI-REALIZATION-DATE... 300 8.161 ORDER-WLR-MOD-STATUS... 300 8.162 ORDER-WLR-RMV-STATUS... 301 8.163 ORDER-WLR-CHG-NTV... 302 8.164 ORDER-WLR-INS-WITH-PARAMS... 304 8.165 ORDER-WLR-REALIZATION-STATUS... 306 9 Słowniki... 307 9.1 ABORT-REASON... 307 9.2 ACC-STATUS... 309 9.3 ACCEPTANCE-RESULT... 309 9.4 ACCEPTANCE-STATUS... 309 9.5 ACCESS-TIME... 309 9.6 ADDRMV-TYPE... 310 9.7 ANNEXATION-STATUS... 310 9.8 ANNEXATION-TYPE... 310 9.9 ASSISTANCE-STATUS... 310 9.10 ATM-TYPE... 311 9.11 BSA-MOD-TYPE... 311 9.12 BSA-TECHNOLOGY... 311 9.13 BSA-TYPE... 311 9.14 BUSL-STATUS-DICT... 312 9.15 CEASE-MODE... 312 9.16 CHANNELS-NUMBER... 312 9.17 CHECK-STATUS-DICT... 312 9.18 CLAIM... 312 MWD Komunikat dla usług komrcjnch wrsja 4.3-2-1.6 11
9.19 COMPLAINT-STATUS-DICT... 313 9.20 COMPLAINT-TYPE... 313 9.21 DDI-NUMBERS... 313 9.22 EQUIPMENT-STATUS... 313 9.23 FAULT-SERVICE-TYPE... 314 9.24 FAULT-STATUS... 314 9.25 FV-STATUS... 314 9.26 GENERAL-SERVICE-TYPE... 314 9.27 ISDN-TYPE... 315 9.28 LINK-TYPE... 315 9.29 LOC-FLAG... 315 9.30 MASS-OPERATION-MODE... 315 9.31 MASS-OPERATION-SUBJECT... 316 9.32 MEETING-SLOT... 316 9.33 MOD-LOC-TYPE... 316 9.34 MODIFICATION-TYPE... 316 9.35 MSG-VER... 317 9.36 NP-TYPE... 317 9.37 OPTION-TYPE... 317 9.38 ORDER-MODE... 319 9.39 ORDER-TYPE... 319 9.40 PROOF-STATUS... 320 9.41 REALIZATION-STATUS... 320 9.42 RESIGN-TYPE... 320 9.43 RTN-RESPONSIBILITY... 321 9.44 SERVICE-TYPE... 321 9.45 SLA-NTV... 321 MWD Komunikat dla usług komrcjnch wrsja 4.3-2-1.6 12
9.46 SLA-TYPE... 322 9.47 STATE... 322 9.48 TEST-VER... 322 9.49 TP-SERVICE-TYPE... 322 9.50 TV-STATUS... 323 9.51 USER-ACTIVATION... 323 9.52 VAS-ACTION... 323 9.53 VAS-ACTION-STATUS... 323 9.54 VAS-OPTIONAL-TYPE... 324 9.55 VAS-TYPE... 324 9.56 VAS-VALUE-TYPES... 325 9.57 VERIFICATION-STATUS... 325 9.58 VI... 325 9.59 VOICE-TYPE... 326 9.60 WLR-INSTALL-LINE-TYPE... 326 9.61 Kod odrzucń... 327 9.61.1 CANCEL-ORDER-DICT... 327 9.61.2 COMPLAINT-PROLONG... 327 9.61.3 COMPLAINT-REJECT... 327 9.61.4 COMPLAINT-RESULT... 328 9.61.5 COMPLAINT-SUBJECT... 328 9.61.6 EC-FIA... 329 9.61.7 FV-DONOR... 330 9.61.8 FV-DONORHOST... 331 9.61.9 FV-HOST... 331 9.61.10 FV-TP... 332 9.61.11 NTV... 334 MWD Komunikat dla usług komrcjnch wrsja 4.3-2-1.6 13
9.61.12 RR-FIA... 335 9.61.13 RTN... 336 9.61.14 SYMPTOMS... 337 10 Załączniki... 339 10.1 Dopuszczaln kombinacj usług zamawianch i usług, z którch następuj rzgnacja... 339 10.2 Format załącznik do komunikatu FAULT-PRIORITY-DATABASE-UPDATE... 341 10.3 Format załącznika do komunikatu MASS-IMPORT oraz MASS-IMPORT-STATUS 341 10.4 Obsługa zamówiń na Tldiagnostkę i Rstart Portu... 342 10.4.1 Wstęp... 342 10.4.2 Tp podstawow... 342 10.4.3 Tchniczna spcfikacja rkordów... 342 10.5 rror... 342 10.6 TstRsult... 343 10.7 TstDataCatgor... 345 10.8 TstData... 346 10.8.1 Komunikat... 346 10.8.2 Słowniki... 355 10.9 Obsługa procsu Wstępnj Wrfikacji Tchnicznj... 355 10.9.1 Wstęp... 355 10.9.2 Tp podstawow... 355 10.9.3 Komunikat... 355 10.9.4 Słowniki... 360 MWD Komunikat dla usług komrcjnch wrsja 4.3-2-1.6 14
1 Dokumnt powiązan L.p. Wrsja Data [1] MWD Procs dla usług komrcjnch 4.3 2014-02-14 [2] MWD Procs (Infrastruktura) dla Modlu Współprac Międzopratorskij zgodn z Ofrtą Ramową (SOR) 0.7 2011-05-27 2 Słownik pojęć W dokumnci wkorzstwano pojęcia z [1]. 3 Wstęp Dokumnt stanowi tchniczną spcfikację komunikacji zdfiniowanj w dokumnci [1]. Dokumnt ni opisuj przbigu procsów, możliwch scnariusz, poszczgólnch kroków, dozwolonch czasów odpowidzi. Wszstki t informacj zawart są w dokumnci [1]. W rozdzial 4 opisano zasad komunikacji. Rozdział 5 opisuj mapowania komunikatów na rozdział dokumntu [1]. Rozdział 6 opisuj tp danch wkorzstwan w komunikacji. Rozdział 7 opisuj struktur wkorzstwan w komunikacji. Rozdział 8 opisuj komunikat jaki są przsłan w ramach Modlu Wmian Danch. Rozdział 9 dfiniuj słowniki. W rozdzial 10 zamiszczono załączniki do dokumntu Opisan w dokumnci zasad komunikacji obowiązują zarówno część hurtową Orang Polska (Hurt) jak i Przdsiębiorcę Tlkomunkacjngo (PT) przstępującgo do Modlu Wmian Danch (MWD) zgodni z [1]. 3.1 Zasad numrowania dokumntu MWDK Dokumnt będzi odnosił się do numracji dokumntu [1] zgodni z następującą konwncją MWDK_[wrsja dokumntu MWDP]-[tap_implmntacji]-[wrsja dokumntu MWDK dla danj wrsji MWDP].[podwrsja MWDK (zmian dcjn)] Etap implmntacji będą oznaczan następująco: 0 - wrsja draft, przznaczona do konsultacji 1 wrsja po zamknięciu konsultacji (skirowana do konstrukcji kodu) 2 wrsja wdrożona produkcjni Przkładowo wrsja 4.0-0-15.0 oznacza: MWDK dla MWDP w wrsji 4.0 wrsja 15.0 MWDK dla MWDP w wrsji 4.0 jst to wrsja do konsultacji Załóżm, ż wrsja ta podlgała konsultacjom. Po uwzględniniu uwag opratorów powstani koljna wrsja 4.0-1-16.0, czli: MWDK dla MWDP w wrsji 4.0 wrsja 16 MWDK dla MWDP w wrsji 4.0 jst to wrsja po zamknięciu konsultacji (skirowana do konstrukcji kodu) MWD Komunikat dla usług komrcjnch wrsja 4.3-2-1.6 15
4 Zasad komunikacji 4.1 Mapowani danch biznsowch na komunikat tchniczn Dokumnt [1] opisuj przbig procsów obsługi usług hurtowch. Ninijsz dokumnt przdstawia w jaki sposób dan zakrs informacjn ma zostać przsłan pomiędz sstmami informatcznmi. Stąd prz każdm komunikaci wróżniono numr rozdziału w dokumnci [1] jaką spcfikuj np. komunikat TECHNICAL_PROOF spcfikuj zakrs danch przsłanch w kroku 3.5.1. Dla rozdziałów nazwanch w [1] "Wrfikacja informatczna" wsłan jst zawsz komunikat tchniczn ACK, któr informuj o przjęciu lub odrzucniu zlcnia. Zgodni z rozdziałm Schmat komunikacji komunikat tchniczn ACK są wsłan przsłan dla wszstkich komunikatów biznsowch. W przpadku komunikatów kirowanch do różnch aktorów, komunikat rozdzilono nazwniczo zgodni z poniższa tablą: Aktor Sufiks Przkładow komunikat Orang Hurt brak ORDER-MIGRATION Biorca brak ORDER-NEW-REALIZATION-DATE-NEG Dawca -TO-DONOR ORDER-NEW-REALIZATION-DATE-NEG-TO-DONOR Oprator Macirzst -TO-HOST ORDER-NEW-REALIZATION-DATE-NEG-TO-HOST W takim wpadku prz komunikaci zaznaczono iż dotcz on komunikacji z konkrtnm aktorm. Wjątkim jst komunikat anulowania zamówinia CANCEL-ORDER-POS, któr moż bć wsłan do wszstkich aktorów (bz wróżninia w nazwi komunikatu do kogo jst kirowan). W przpadku gd dan Przdsiębiorca Tlkomunikacjn wstępuj w danm procsi w dwóch rolach np. Dawc i Opratora Macirzstgo zostaną do nigo wsłan dwa komunikat. Komunikat potwirdzając anulowania zlcnia są wsłan do wszstkich uczstników procsu nawt do Przdsiębiorstwa Tlkomunikacjngo, z którgo powodu anulowano zlcni. Prz tworzniu nazw komunikatów przjęto nastpującą konwncję nazwniczą Sufiks Rozwinięci (ang.) Znaczni -STATUS- Komunikat jst informacją o statusi zlcnia/zamówinia lub informuj o jgo wniku. -FV formal vrification Wnik wrfikacji formalnj -NFV ngativ formal vrification Ngatwn wnik wrfikacji formalnj -PTV positiv tchnical vrification Poztwn wnik wrfikacji tchnicznj -NTV ngativ tchnical vrification Ngatwn wnik wrfikacji tchnicznj Dla ułatwinia wszstki mapowania komunikatów zbrano w rozdzial Tabla mapowania komunikatów na rozdział MWDP 4.2 Schmat komunikacji Komunikacja w ramach MWD jst ralizowana zawsz wg tgo samgo schmatu. MWD Komunikat dla usług komrcjnch wrsja 4.3-2-1.6 16
Dan wspóln dla wszstkich komunikatów wdzilono do nagłówka MSG-HEADER. Komunikat wminian w ramach jdngo procsu są powiązan poprzz pol ordr-numbr (Idntfikator zamówinia / zgłosznia). W ramach pojdnczgo procsu moż dojść do wilu intrakcji (wmian danch). Pojdncza intrakcja składa się z wsłania odpowidnigo komunikatu przz nadawcę oraz odbrania lub odrzucnia przz odbiorcę skorlowan prz pomoc pola intraction-id. Nadawca wsła komunikat dfiniując następując pola nagłówka: Pol intraction-id Znaczni numr intrakcji rozumian jako wsłani komunikatu oraz otrzmania potwirdznia (komunikatu ACK). Taka para komunikatów posiada wspóln numr intrakcji. Idntfikator intrakcji (INTERACTION-ID) musi bć unikalnm idntfikatorm wmian danch w obrębi dango źródła komunikatu (Przdsiębiorc tlkomunikacjngo). Idntfikator tn będzi liczbą całkowitą o długości maksmalnj 15 znaków [INT(15)]. Idntfikator ni musi zachowwać skwncjności numracji. Wszstki komunikat niosąc trść biznsową są sparowan z odpowidnim komunikatm potwirdznia. Komunikat ABORT ni jst on w snsi ścisłm częścią intrakcji w ramach którj został wsłan, a jdni sgnałm, ż intrakcja się ni powiodła. subjct-id dst-subjct-id ordr-numbr numr jdnoznaczni idntfikując nadawcę komunikatu poprzz numr pod jakim Oprator figuruj w rjstrz przdsiębiorców tlkomunikacjnch UKE. Na potrzb ninijszgo modlu wmian danch Orang-Hurt będzi posiadała idntfikator 0 numr jdnoznaczni idntfikując odbiorcę komunikatu poprzz numr pod jakim Oprator figuruj w rjstrz przdsiębiorców tlkomunikacjnch UKE. Na potrzb ninijszgo modlu wmian danch Orang-Hurt będzi posiadała idntfikator 0 numr oznaczając idntfikator zamówinia/zgłosznia, dla komunikatów rozpocznającch procs numr musi bć unikaln w ramach jdngo PT MWD Komunikat dla usług komrcjnch wrsja 4.3-2-1.6 17
msg-vr tst-vr stat W przpadku gd: pol okrślając zgodni z którą wrsją MWD przgotowan został komunikat. W wpadku komunikatów zgodnch z ninijszm MWD jgo wartość będzi wnosiła "SOR [wrsja dokumntu MWDP]-[wrsja dokumntu MWDK dla danj wrsji MWDP]" (patrz Zasad numrowania dokumntu MWDK). W przpadku popraw błędów lub wprowadzania rozszrzń funkcjonalnch wartość ta moż ulgać zmiani. Stąd opratorz korzstając z kanału WbSrvic powinni bć przgotowani na taką zmianę. pol okrślając, cz komunikat jst komunikatm produkcjnm cz tstowm. Stron w wpadkach szczgólnch dopuszczają możliwość wsłania komunikatów tstowch na środowisku produkcjnm. Komunikat taki spowoduj odsłani właściwgo komunikatu potwirdznia ACK jdnak bz uruchamiania procsów biznsowch pol okrślając stan intrakcji w ramach którgo nastąpiło gnrowania komunikatu. Dopuszczaln wartości to REQ dla żądania, ACK dla potwirdznia i ABR dla komunikatu. Dodatkowa wartość ATTACHMENT jst wkorzstwana prz przsłaniu plików (patrz Przsłani plików) 1. odbiorca ni jst w stani odbrać/odcztać komunikatu (z powodu błędów krtcznch w strukturz wiadomości, nipoprawngo uwirztlninia nadawc, awarii sstmu, włącznia sstmu na czas prac konsrwacjnch, włącznia kanału komunikacjngo itp.) odpowiada nadawc komunikatm ABORT 2. przsłan komunikat ni spłnia wmagań nakładanch na dan komunikat, w szczgólności a) brakuj wmagalnch pól b) wartości pól są nizgodn z tpm lub wartościami słownikowmi c) komunikat ni spłnia wspcfikowanch dla każdgo komunikatu rguł odbiorca odpowiada komunikatm ACK z flagą acc-status=odrzucon oraz opism błędu (pol rjction-rason-cod) zgodnm z słownikim VI 3. w przciwnm wpadku odbiorca odpowiada komunikatm ACK z flagą acc-status=przjęt, któr potwirdza dostarczni komunikatu Komunikat ABORT oraz ACK powinn posiadać idntczn pol intraction-id jak w komunikaci od nadawc. Po otrzmaniu informacji o odrzucniu wiadomości nadawca moż ponowni wsłać poprawion komunikat al z zminioną wartością pola intraction-id (pol ordr-numbr moż pozostać bz zmian). W przpadku gd odbiorca ni odpowi komunikatm ABORT lub ACK na komunikat biznsow nadawc w przciągu 30 minut, nadawca moż przsłać ponowni tn sam komunikat z takim samm intraction-id. Odbiorca powinin zignorować zdublowan komunikat jśli jgo trśc jst idntczna (jśli trść jst różna wtd odbiorca powinin odpowidzić komunikatm ABORT z błędm 1007). Zakłada się, ż dan komunikat będzi powtarzan maksmalni 2 raz. Jśli odbiorca nadal ni odpowi nadawca powinin zgłosić awarię ISI zgodni z odpowidnim procsm zdfiniowanm w [2]. Wskazan dokumnt opisuj takż obsługę prac planowch na sstmach informatcznch Po naprawi awarii komunikat moż bć ponowni wsłan przz nadawcę do odbiorc Z względu na fakt, iż Orang-Hurt jst zobligowan do dotrzmania czasów ralizacji poszczgólnch kroków procsu zdfiniowanch w SOR, Orang-Hurt kontnuuj ralizację procsu ni czkając na dostarczni komunikatu do OA. Brak potwirdznia dostarcznia komunikatu lub odrzucni komunikatu przz OA oznacza błąd w komunikacji Orang-Hurt wrfikuj wszstki przchodząc komunikat zgodni z poniższm schmatm: MWD Komunikat dla usług komrcjnch wrsja 4.3-2-1.6 18
wrfikacja informatczna przdwstępna (w przpadku nipowodznia powoduj wsłani komunikatu ABORT) o wrfikacja cz nadawca ma uprawninia do komunikacji kanałm przchodzącm o wrfikacja cz komunikat jst możliw do odszfrowania i odcztania o wrfikacja cz komunikat posiada prawidłow pol intraction-id. wrfikacja informatczna (w przpadku nipowodznia powoduj wsłani komunikatu ACK z flagą acc-status=odrzucon) o wrfikacja wrsji MWD oraz jj zgodności przsłango komunikatu o wrfikacja cz komunikat posiada wmagan pola o wrfikacja cz pola komunikatu mają prawidłow format tchniczn o wrfikacja cz wskazan dat ralizacji zamówinia/zlcnia spłniają warunki wspcfikowan w [1] wrfikacja formalna polga na sprawdzniu poprawności danch biznsowch, w komunikaci zawsz jst poprzdzona wsłanim komunikatu ACK z flagą accstatus=przjęt. Ewntualn błęd sa zwracan jako osobn komunikat zdfiniowan w [1] W przpadku odrzucnia zamówinia/zgłosznia na tapi wrfikacji formalnj koniczn jst przsłani zamówinia z nowm numrm ordr-numbr Wjątkim dla powższgo są komunikat TECHNICAL-PROOF, MASS-IMPORT, ORDER-VPVC- MOD, któr umożlwiają korktę zamówinia Komunikat FAULT-SERVICE można wsłać z tm samm ordr-numbr w przpadku, gd Biorca stwirdzi brak usunięcia uszkodznia (szczgół dotcząc procsu opisano w [1]) W ramach pojdnczj intrakcji istnij możliwość przsłania tlko pojdnczgo komunikatu. Spcfikacja ni umożliwia przsłani wilu komunikatów na raz (paczkowani komunikatów). 4.3 Kanał komunikacjn Komunikat zdfiniowan w ninijszj spcfikacji mogą bć przsłan poprzz jdn z następującch kanałów komunikacji WbSrvic WWW Kanał WWW jst ralizowan na infrastrukturz Orang-Hurt. Kanał WbSrvic wmaga od Przdsiębiorc Tlkomunikacjngo zapwninia własnj części infrastruktur nizbędnj do wmian informacji. 4.3.1 Format komunikatu Komunikat będą zapisan w stroni kodowj UTF-8. W clu umożliwinia kontroli postaci plików XML, Orang Polska przkaż Przdsiębiorcom Tlkomunikacjnm schmat XSD pozwalając na parsowani zawartości komunikatów przd ich wsłanim. Nalż zaznaczć, iż XML Schma ni pozwala na wrfikację wszstkich rguł zawartch w spcfikacji np. wmagalności pól w zalżności od wartości innch pól. Są to ogranicznia samgo standardu XML Schma. Dan konfiguracjn XML Dana root-tag namspac nampspac (dla komunikatu Wartość cbnp-mssag http://www.tp.pl/cbnp/cbnp-xml-protocol/vr_5_3 http://www.tp.pl/cbnp/cbnp-xml-protocol/vr_4_1 MWD Komunikat dla usług komrcjnch wrsja 4.3-2-1.6 19
ABORT w przpadku, gd w komunikaci tpu REQ brakowało pola intraction-id lub ordr-numbr. W takim wpadku ABORT ni zawira danch, którch ni otrzmał) 4.4 Kanał WbSrvic Kanał WbSrvic udostępnia możliwość przsłania komunikatów MWD w tchnologii WbSrvic. 4.4.1 Dan konfiguracjn kanału Do uruchominia kanału koniczn są następując dan konfiguracjn Dostarczon przz Orang-Hurt Orang-Hurt i PT Orang-Hurt i PT Orang-Hurt i PT Orang-Hurt i PT Orang-Hurt Orang-Hurt Orang-Hurt Orang-Hurt Orang-Hurt Orang-Hurt Orang-Hurt Orang-Hurt Spcfikacja WSDL Dana konfiguracjna URL pod jakim dostępn jst WbSrvic crtfikat SSL srwra crtfikat SSL klinta dan kontaktow do administratora sstmu (imię i nazwisko, nr tlfonu, adrs -mail) maksmaln rozmiar załącznika (po rozpakowaniu) maksmaln rozmiar paczki w komunikaci ATTACHEMENTS maksmalna liczba komunikatów produkcjnch w jdnostc czasu maksmalna liczba komunikatów tstowch w jdnostc czasu maksmalna ilość ponowiń prz braku ACK odstęp czasu pomiędz koljnmi ponowiniami komunikatu (brak ACK) maksmalna ilość ponowiń prz braku HTTP 200 OK maksmaln czas przz jaki ponawian jst komunikat (brak HTTP 200 OK) 4.4.2 Spcfikacja tchniczna kanału komunikat MWD SOAP Protokół HTTP mtoda POST 1.1 Wrsja/Spcfikacja XML 1.0 kodowani UTF-8 WS-I Basic Profil 1.1 / On-Wa Opration Komunikat będą przkazwan w trbi asnchronicznm zgodni z zasadami komunikacji jdnokirunkowj (On-Wa Opration, komunikacja tpu "push") zawartj w spcfikacji Basic Profil MWD Komunikat dla usług komrcjnch wrsja 4.3-2-1.6 20
w wrsji 1.1 opublikowaną przz Wb Srvics Introprabilit Organization (http://www.wsi.org/profils/basicprofil-1.1.html). 4.4.3 Sposób przsłania komunikatów w kanal Komunikat MWD będą przsłan w kanal uzupłnion o nagłówk SOAP. Sposób przsłu SOAP został pokazan poniżj Nadawca przsła komunikat SOAP do odbiorc. Komunikat podlga autorzacji nadawc. W przpadku braku autorzacji wsłan jst komunikat HTTP 401 (bz koprt SOAP). W przpadku przkrocznia dozwolonj ilości komunikatów w jdnostc czasu zwracan jst błąd HTTP 429 (Too Man Rqust). Obowiązują osobn limit dla komunikatów tstowch i produkcjnch. W przpadku poprawnj transmisji komunikatu SOAP odbiorca odsła nadawc komunikat HTTP 200 (bz koprt SOAP). Oznacza on jdni poprawn dostarczni komunikatu. Ni oznacza poprawności samgo komunikatu MWD. Ni oznacza on takż wsłania komunikatu ACK. Taki komunikat jst wsłan jako now komunikat SOAP. W kanal obowiązują nastpując zasad: odpowidź HTTP instancji srwisu ni moż zawirać koprt SOAP, ani tż innj trści (poza informacją statusową dotczącą transmisji HTTP) klint srwisu musi ignorować wntualną koprtę SOAP przkazaną w odpowidzi HTTP klint srwisu ni moż intrprtować pomślngo statusu transmisji HTTP (np. 200 bądź 202) jako uznani komunikatu za prawidłow cz tż przjęt do prztwarzania żądania powinn bć przkazwan do srwisu mtodą POST status przkazan w odpowidzi HTTP z stron srwisu oznaczając błąd oznacza błąd na poziomi transmisji i ni nisi informacji o wntualnch błędach żądania SOAP w przpadku poprawnj transmisji HTTP srwis udzili odpowidzi z statusm 200 MWD Komunikat dla usług komrcjnch wrsja 4.3-2-1.6 21
w przpadku braku poztwnj odpowidzi HTTP nadawca moż ponowić wsłani komunikatu, zakłada się 2-krotn ponowini z intrwałm 30 minut; jśli odbiorca nadal ni odpowi nadawca powinin zgłosić awarię ISI zgodni z odpowidnim procsm zdfiniowanm w [2]. Ilość ponowiń moż ulc zmiani w razi potrzb. srwis będzi akcptował w nagłówku SOAP (soap:hadr) znaczniki Mssag-Id oraz In- Rpl-To Poniżj zamiszczono przkładow komunikat SOAP wraz z trścią biznsową. Przkład pokazuj jdni sposób opakowania komunikatu biznsowgo poprzz nagłówki SOAP. Zgodność przkładu z spcfikacją komunikatów moż ni bć zachowana <soapnv:envlop xmlns:soapnv="http://schmas.xmlsoap.org/soap/nvlop/" xmlns:tp="http://www.tp.pl/wsadaptr/tps"> <soapnv:hadr/> <soapnv:bod> <tp:documntrqust> <cbnp-mssag:cbnp-mssag xmlns="http://www.tp.pl/cbnp/cbnp-xmlprotocol/vr_5_3" xmlns:cbnp-mssag="http://www.tp.pl/cbnp/cbnp-xmlprotocol/vr_5_3"> <msg-hadr> <intraction-id></intraction-id> <subjct-id>39999</subjct-id> <dst-subjct-id>0</dst-subjct-id> <ordr-numbr></ordr-numbr> <msg-vr>sor 4.3-1</msg-vr> <tst-vr>0</tst-vr> <stat>req</stat> </msg-hadr> <ordr-ins-inactiv> <ordr-tp>6</ordr-tp> <rcipint-nam>56</rcipint-nam> <customr-addrss> <cit-nam>katowice</cit-nam> <strt-nam>ścianowa</strt-nam> <proprt-numbr>3</proprt-numbr> <flat-numbr>9</flat-numbr> <postal-cod>10-846</postal-cod> </customr-addrss> <customr-nam>posti</customr-nam> <customr-contact> <nam>posti</nam> <phon-numbr>325676655</phon-numbr> </customr-contact> <oprator-tchnical-contact> <nam>jan KOWALSKI</nam> <phon-numbr>415676655</phon-numbr> </oprator-tchnical-contact> <implmntation-dat>2011-09-30</implmntation-dat> <customr-claim>0</customr-claim> <ordr-itm> <srvic-tp>1</srvic-tp> <voic> <voic-tp>1</voic-tp> <prslction> <prslction-dom>1066</prslction-dom> <prslction-int>1066</prslction-int> </prslction> </voic> </ordr-itm> MWD Komunikat dla usług komrcjnch wrsja 4.3-2-1.6 22
</ordr-ins-inactiv> </cbnp-mssag:cbnp-mssag> </tp:documntrqust> </soapnv:bod> </soapnv:envlop> 4.4.4 Zasad bzpiczństwa przsłu danch w kanal Kanał WbSrvic wkorzstuj zabzpiczni trasmisji danch poprzz zastosowani protokołu HTTPS z uwirztlninim po stroni srwra i stroni klinta. Do uwirztlninia będą wkorzstwan crtfikat. 4.4.5 Przsłani plików w kanal WbSrvic W przpadku, gd polm komunikatu jst plik obowiązują następując zasad jgo przsłania: 1. Pol w komunikaci zawirając nazwę pliku jst tpu DOCUMENT 2. W ramach tj samj intrakcji plik (lub kilka plików) po spakowaniu do archiwum ZIP jst przsłan osobnm komunikatm ATTACHMENTS przd lub po wsłaniu właściwgo komunikatu, lcz z tm samm polm ordr-numbr oraz intraction-id w nagłówku MSG- HEADER 3. W ramach jdnj intrakcji odbiorca oczkuj na liczbę attachmnt-quantit komunikatów tpu ATTACHEMENTS oraz jdn komunikat biznsow (stat=req), po czm odsła komunikat ACK potwirdzając poprawność wszstkich komunikatów w intrakcji. Odbiorca zgłasza błąd do pirwszgo wkrtgo komunikatu. Nadawca ponawia komunikat, dla którch ni dostał potwirdznia dostarcznia, zgodni z ogólnmi zasadami ponawiania 4. Załączniki muszą bć kodowan w standardzi BASE64 5. Rozmiar załączongo do komunikatu ATTACHMENTS(spakowango) pliku ni moż przkroczć wartości konfiguracjnj (obcni 10MB). W przpadku większch plików, Nadawca musi podzilić plik korzstając z standardu ZIP i wsłać jako oddziln paczki (osobn komunikat ATTACHMENTS) 6. Przwiduj się możliwość przsłania następującch formatów plików PDF, JPG, RTF, DOC, TXT, XLS, TIFF. Przsłani innch formatów jst dozwolon natomiast jśli ich odcztani ni będzi możliw prz użciu oprogramowania wkorzstwango przz Odbiorcę, załącznik ni będzi bran pod uwagę prz procsowaniu zlcnia. Odbiorca i nadawca mogą uzgodnić rozszrzoną listę obsługiwanch formatów. 7. Wilkość pliku załącznika (po rozpakowaniu) przsłango kanałm WbSrvic ni moż przkroczć wartości 47,68 MB (50000000 bajtów) 8. Nazw plików przsłanch w ramach komunikatów MWDK są ograniczon formatm oraz zakrsm dozwolonch znaków. Nazwa moż zawirać cfr oraz duż i mał litr, takż z polskigo alfabtu. Nazwa przsłango pliku moż zawirać rozszrzni, al ni jst to koniczn. Dozwolonmi znakami spcjalnmi są: spacja "\s", podkrślni "_", mślnik "-". Nidozwolon jst równiż wstawiani w nazwę pliku dwóch kropk obok sobi, co przntuj przkład: "aaa..bb.zip". Przkład przsłania plików Zakładam wsłkę dwóch plików a.doc oraz b.pdf jako załączników do komunikatu biznsowgo. W komunikaci biznsowm w polach fil-id (patrz DOCUMENT) nalż podać fil-id=a.doc oraz filid=b.pdf. Następni oba pliki mogą zostać spakowan do jdngo archiwum x.zip. Nazwę pliku x.zip nalż podać w polu fil-nam w komunikaci ATTACHMENTS. Jśli wilkość pliku x.zip jst większa niż 10 MB to nalż podzilić plik na mnijsz i wsłać jako osobn paczki. Opcjonalni do powższgo nadawca moż spakować każd plik osobno (a.zip i b.zip) i przsłać w jdnm lub w kilku komunikatach ATTACHMENTS Poniższ rsunk pokazuj scnariusz przsłania plików załącznika w dwóch paczkach Wartości X, Y nalż zastąpić wartościami liczbowmi zgodni z spcfikacją. Wartość attachmntguantit informuj o ilości paczk natomiast attachmnt-numbr jst numrm konkrtnj paczki. MWD Komunikat dla usług komrcjnch wrsja 4.3-2-1.6 23