Squire SVI STP SSME User Manual Download | Manualshive

Page: 43 / 57

background image

SVI-STP SSME

Squire Technologies - Confidential Document

Page

43

of

57

6

API Server

6.1

Overview

The STP SSME is capable of routing messages to an external API for examination and routing decision
based on the XML configuration. (See section 9 for details of the Python SDK)

The attribute

apiserver

in the <route> element will inform the STP to route the message internally to

an API server function. The API server is connected to the STP via TCP and is documented in the
relevant API user guides.

In the <linkset> element the

apiserver

attribute is used to inform the STP SSME engine that the

message was received from an external application.

The API server name must match a API resource configured in the STP main configuration (if not
configured then the configuration will not accepted by the SVI-STP)

For Example

The configuration of this could be that based on the SCCP called party a message received from STP 1
could be routed to either:



API Server 1



API Server 2



STP 2

If a message is routed to API Server 1 then this application could either change some of the incoming
parameters for example the SCCP Called Party Address and then resubmit to the SVI-STP for re-
routing.

The following XML example works on the following method:



Messages are received from Linkset LS-ETSI-OPC-8000-DPC-7100

o

If the incoming message is a MAP operation “Send Routing Info” then forward the
message to the API server.

«
...
41
42
43
44
45
...
»

Summary of Contents for SVI STP SSME

Page 1: ...ained herein is confidential This document either in whole or in part must not be reproduced or disclosed to others or used for purposes other than that for which it has been supplied without Squire Technologies prior written permission or if any part hereof is furnished by virtue of a contract with a third party as expressly authorised under that contract ...

Page 2: ...t Updated 2017 2 5 Content Updated MC SS 08 11 2019 2 6 Images Updated MC SS 08 11 2019 2 7 Corporate formatting applied SS SS 12 11 2019 2 8 Removed Squire footer page SS SS 12 11 2019 2 9 Spelling Grammar checked SS SS 12 11 2019 3 0 Change History applied SS SS 12 11 2019 3 0 Updated Document Number LJ LJ 08 01 2020 3 1 Updated SSME references SS SS 27 04 2020 ...

Page 3: ... 1 Overview 13 4 2 Matching and Translation 14 4 2 1 Match 15 4 2 2 MTPMatch 16 4 2 3 SCCPMatch 17 4 2 4 GTTMatch 18 4 2 5 Nesting 19 4 2 6 Ordering using First Match 22 4 3 Instructions 23 4 3 1 CommandList 23 4 3 2 Command 24 4 4 Routing Types 25 4 4 1 Screening 25 4 4 2 Map Layer Routing 27 4 4 3 Map Layer Translations 32 4 4 4 Global Title Routing 35 4 4 5 MTP Routing 35 4 5 SCCP Best Match Ma...

Page 4: ...ing Digits 48 7 2 3 Replacing Leading Digits 48 7 2 4 Perform number translation 48 8 Debug 49 8 1 Description 49 8 2 Debug Levels 49 8 3 Debug PCAP Configuration 49 8 4 XML Configuration 49 9 Internal Testing 50 9 1 Description 50 9 2 Test 50 9 3 Expected Output 50 10 Python SDK 53 10 1 Overview 53 11 Schema Validation and Configuration 54 11 1 Configuration 54 11 2 Load XML File 55 11 3 Configur...

Page 5: ...rformed on the transmitted message o SCCP Called and Calling Address modification pre and post can be performed o MAP operation code and Map Layer Parameter Contents MTP Routing and manipulation based on the following attributes o MTP OPC DPC NI modification allowed on MTP attributes o Routing can be to another linkset AS or an API server GT Title Translations o SCCP Called and Calling Address can...

Page 6: ...ngine The SSME routing engine will return on of the following Reject Return Error to the calling party for SCCP only if the return on error flag is set Ignore Discard the message Route Sets the route for the outgoing message and then will return to the SSME routing engine for any GT Transactions NoRoute Match NoMatch on all these returns the STP SSME will attempt to use the internal routing engine...

Page 7: ...message Ignore Match found configuration states ignore message Route Match found configuration states route and route is available NoRoute Match found configuration states route and route is unavailable MTP Message Recv Ssme Cfg for Linkset Process Std MTP Routing SSME Routing Engine Ssme Rtn Ignore Ssme Rtn Reject Discard Message Send UDTS if applicable Ssme Rtn Route GT Translatio n Forward Msg ...

Page 8: ...tProfile Contains a list of entry points to be used to route the message Linkset Specifies a list of entry points to be used to route the message or a linkset profile to be used LsEp Entry point list for a linkset 2 3 2 Routing Criteria The XML elements used for selecting an outbound route are as follows EntryPoint Defines a list of matches to be performed Match Criteria to a match a message gener...

Page 9: ...e used 2 3 4 Global Title Translation The XML elements used for selecting an outbound route are as follows EntryPoint Defines a list of matches to be performed GTTMatch Criteria to a match a message generally CommandList Defines a list of commands that must be performed in order Command Defines a command to be performed ...

Page 10: ...are present then use the Ep listed by the mtpRouting attribute Depending on the return of processing the following will be performed If ignore is returned then it will always discard the message If reject is returned the it will send a UDTS if the protocol is SCCP and the return on Error Flag is set to the Calling Address otherwise the message discard If a route is returned then the default behavi...

Page 11: ...igure a linkset element for each linkset configured in the SVI STP 3 1 3 LsEp This element allows the SSME to jump to an entry point it can also perform actions on the return value these actions include Change the return value Jump to another LsEp element within the list The Jump and Return attributes will override the normal processing for the Linkset or Linkset Profile Elements The Jump and Retu...

Page 12: ...bute used for GT Translations Ep elements can jump to another Ep Example It will return a result containing the following information Match A match has been found from the inbound data but no attempt has been made to route the message NoMatch No match has been found from the inbound data Ignore A match has been found from the inbound data but has been instructed to return Ignore Reject A match has...

Page 13: ...called and calling digits that can be made regular expressions are just a match or no match the length of the match is not used unless the first match attribute is set on the parent element in which case the first match is chosen Determine the action for the message is it o Route then return the routing information and update the required message fields for the outgoing message o Ignore return Ign...

Page 14: ...ncoming address if an attribute is not present then it is not required as part of the match Translations occur after the best match element has been selected it will inherit all the nesting aspects that have part of the matching element If a clash occurs on the setting of a translation the innermost match is selected If an attribute is not present then it is unchanged ...

Page 15: ...ccp cdpn digits Outbound MTP OPC og mtp opc Outbound SCCP Calling Party Nature of Address og sccp cgpa noa 4 2 1 1 Matching Example match incoming DPC 9987 Match ic mtp dpc 9987 Example match incoming DPC 9987 and OPC 1234 or 1235 Match ic mtp dpc 9987 Match ic mtp dpc 1234 Match ic mtp opc 1235 Match 4 2 1 2 Translations Example match incoming DPC 9987 translate to DPC 1234 Match ic mtp dpc 9987 ...

Page 16: ...c 2345 Match ic mtp opc 1235 og mtp opc 3456 Match 4 2 2 MTPMatch The MTPMatch Element references all its attributes by the following Attribute Type Incoming Outgoing MTP ic mtp attr attr og mtp attr SCCP ic sccp attr og sccp attr TCAP tcap operationCode MAP map routing_expr Examples Incoming MTP DPC dpc Incoming SCCP Called Party Digits ic sccp cdpn digits Outbound MTP OPC og mtp opc Outbound SCC...

Page 17: ...pc Outbound SCCP Calling Party Nature of Address og sccp cgpa noa 4 2 3 1 Matching Example match incoming SCCP Called Address Prefix 12345 SCCPMatch cdpn digits 12345 Equivalent Match element Match ic sccp cdpn digits 12345 Example match incoming SCCP Called Address Prefix 12345 and Translation Type 2 SCCPMatch cdpn digits 12345 tt 2 Example match incoming SCCP Called Address Prefix 12345 and Tran...

Page 18: ...n Type update Translation Type SCCPMatch tt 2 og sccp cdpn tt 3 SCCPMatch cdpn digits 12345 SCCPMatch cdpn digits 456 SCCPMatch 4 2 4 GTTMatch The GTTMatch Element references all its attributes by the following it is only used on SCCP Addresses Attribute Type Incoming Outgoing SCCP Address attr og attr Examples Incoming SCCP Address Digits digits Outbound SCCP Address Translation Type og tt 4 2 4 ...

Page 19: ...le Add Prefix 123 to all digits 456 GTTMatch digits 456 og prefixDigits 123 Example Replace Prefix 456 with 123 GTTMatch digits 456 og prefixDigits 123 og strip 3 Example Remove Prefix 456 GTTMatch digits 456 og strip 3 4 2 5 Nesting Nesting of match elements is powerful tool that allows nested match to inherit the conditions of its parent as part of the current match For example the user wishes t...

Page 20: ...ute Whereas with the example with nesting this would only require 9 checks Nesting can also be used to split down large groups numbers in the same field so for example the called number digits can be split into smaller prefixes so a user could check cdpn digits 0 followed by a nested element cdpn digits 01 and so forth Consider the following Routing based only on SCCP Cdpn Global Title Digits Ther...

Page 21: ...h SCCPMatch cdpn digits 0 SCCPMatch cdpn digits 01 SCCPMatch cdpn digits 010 SCCPMatch cdpn digits 011 SCCPMatch cdpn digits 012 SCCPMatch cdpn digits 013 SCCPMatch cdpn digits 014 SCCPMatch SCCPMatch SCCPMatch cdpn digits 2 SCCPMatch cdpn digits 51 SCCPMatch cdpn digits 250 SCCPMatch cdpn digits 251 SCCPMatch cdpn digits 252 SCCPMatch cdpn digits 253 SCCPMatch cdpn digits 254 SCCPMatch SCCPMatch ...

Page 22: ...then a large number of comparisons will be made before the best match is returned This value is vital to be set for MtpMatching and GTT Translations as these elements are likely to contain to the most matches at a single nested level For large tables it s recommend to use nesting and firstMatch to provide the best performance 4 2 6 1 Ordering The ordering of matches when using the firstMatch attri...

Page 23: ...ch contains a command list should ONLY be referenced from a LSEP Jumping from an EP to an EP containing a CommandList is NOT supported Example CommandList Ep name ETSI GTT TRANSLATIONS CommandList address Called Calling ic mtp DestinationPoint STP MP CPC ETSI routed mtp OriginatingPoint STP 0 ETSI OPC 10001 Command jump Etsi Translation 1 mode GttTranslation CommandList Ep The CommandList criteria...

Page 24: ...elect an outbound route and perform an updates required to the message All commands in the CommandList are performed in the order proscribed so in the example below CommandList ic sccp cdpn tt 0 address Called Command jump mxr tt 0 pre conversion mode GttTranslation Command jump mxr tt 0 routing mode Action Command jump mxr tt 0 post conversion mode GttTranslation CommandList The User is attemptin...

Page 25: ...urely on MTP pointcodes 4 4 1 Screening There are multiple ways of performing the screening it can be done as part of the normal routing or as separate entry points The user can also select to have more than one entry Point dealing with the Screening this would allow the user to have a generic screening policy that might be used across all linksets but there a have a more specific screening for th...

Page 26: ...lling node o SCCP CDPN digits prefixed 975 and CGPN digits prefixed 4565 will be rejected therefore if the protocol class states return on error a UDTS will be returned to the calling node o SCCP CDPN digits prefixed 689 and MAP Operation Update Location will be rejected therefore if the protocol class states return on error a UDTS will be returned to the calling node The advantage doing it in thi...

Page 27: ... the following options UpdateLocation ProvideRoamingNumber SendRoutingInfoForSM MoForwardShortMsg MtForwardShortMsg AlertServiceCentre AlertServiceCentreNoResult ReportSMDeliveryStatus AnytimeInterrogation SendAuthenticationInfo UpdateGprsLocation MapProcessUnstructedRequest 4 4 2 2 Supported MAP Parameters 4 4 2 2 1Update Location 2 mscNumber o Address digits mscNumber addr digits o Numbering pla...

Page 28: ...Address RpOaMsisdn noa nature of address DestMsisdn Destination Address contained within the User Information of the MoForwardShort Message Data o Address digits DestMsisdn addr digits o Numbering plan DestMsisdn npi numbering plan o Nature of Address DestMsisdn noa nature of address 4 4 2 2 5MtForwardShortMessage 44 Important Note MTForwardSM is handled differently for MAPv2 and MAPv3 due to the ...

Page 29: ...llowing options are available MSISDN o Address digits MSISDN addr digits o Numbering plan MSISDN npi numbering plan o Nature of Address MSISDN noa nature of address UssdStr o String UssdStr decodedString string OrigRef o Address digits OrigRef addr digits o Numbering plan OrigRef npi numbering plan o Nature of Address OrigRef noa nature of address DestRef o Address digits DestRef addr digits o Num...

Page 30: ...ap Layer Routing Using TCAP OpCode Ep name etsi map layer routing SCCPMatch tcap opCode Cancel Location route ETSI Cancel Location route SCCPMatch tcap opCode Any Time Interrogation destination 9986 Ep This example shows that the two Messages Cancel Location and Any Time Interrogation are sent discriminated based on the Map Message Type Ep name etsi map layer routing SCCPMatch cdpn digits 6 tcap o...

Page 31: ...Code Send Routing Info For SM map routing_expr MSISDN addr 6567 0 9 True destination SP2 ETSI SCCPMatch tcap opCode Send Routing Info For SM map routing_expr MSISDN addr 65 0 9 True route ETSI Send Routing Info For SM 65 SCCPMatch tcap opCode Any Time Interrogation map routing_expr GsmSCF addr 2231 0 9 True route ETSI Anytime Interrogation 2231 SCCPMatch tcap opCode Any Time Interrogation map rout...

Page 32: ...e AlertServiceCentreNoResult ReportSMDeliveryStatus AnytimeInterrogation SendAuthenticationInfo UpdateGprsLocation MapProcessUnstructedRequest For UpdateLocation the following options are available mscNumber vlrNumber imsi For ProvideRoamingNumber the following options are available vlrNumber For SendRoutingInfoForSM the following options are available SCAddress MSISDN For MoForwardShortMessage th...

Page 33: ...ntaining the information in the This value can then be used in the map translate in the following manner map translate RpOaMsisdn addr 2 1 Where the 1 contains the value of the substitution More complex expressions can be used for example if the user wishes to perform a translation on both the MSISDN address and service centre address for an incoming message map cnts RpOaMsisdn addr 186 0 9 True a...

Page 34: ...s for a message the following can be performed Ep name etsi map layer routing SCCPMatch map cnts RpOaMsisdn addr 186 0 9 True amp amp SCAddress addr 0 9 True map translate RpOaMsisdn addr 2 1 SCAddress addr 8 2 tcap opCode MO Forward Short Message Ep Ep name etsi map layer routing 1 SCCPMatch id PROXY 0 sms ruleset sms 6 map cnts DestMsisdn addr 18683022222 0 9a fA F True map translate DestMsisdn ...

Page 35: ...l title routing SCCPMatch cgpn digits 12345 route ETSI ETSI SP1 VIA STP TST 1 ONLY Ep 4 4 4 4 Global Title Routing PC Subsystem to Global Title Ep name etsi global title routing SCCPMatch cdpn ri RouteOnSSN cdpn pc 1234 cdpn ssn 6 og sccp cdpn digits 994334432 og sccp cdpn ri RouteOnGT og sccp cdpn gti 1 route ETSI ETSI SP1 VIA STP TST 1 ONLY Ep 4 4 4 5 Global Title Routing Global Title to PC Subs...

Page 36: ...ent Best Match Current Match Current Match Current Best Match Current Best Match Current Match Current Best Match None included Current Best Match Current Match Current Best Match Current Match has more ic sccp cdpn digits than current Best Match None included Current Match Current Match Current Best Match Current Match has less ic sccp cdpn digits than current Best Match None included Current Bes...

Page 37: ...h has equal num digits in ic sccp cdpn digits than current Best Match Both current and current best match have map cnts Current Match has more expressions Current Match Current Match Current Best Match Current Match has equal num digits in ic sccp cdpn digits than current Best Match Both current and current best match have map cnts Current Best Match has more expressions Current Best Match Current...

Page 38: ... the incoming message to the next destination 5 3 Route The Route element is either Sub element of the RouteEp in which case there is only 1 Route element in each RouteEp Sub element of the Routeset in which case there is 1 or more Route elements in each Routeset The Route should describe a unique method of forwarding the message to the next destination They can have the following information for ...

Page 39: ...OUTING MTPMatch dpc 8887 linkset STP0 STP TST 1 ANSI Ep This would then be routed to linkset STP0 STP TST 1 ANSI with the same incoming and outgoing OPC and DPC Destination Only Ep name ETSI ROUTING MTPMatch dpc 8887 destination Destination 1 Ep This would then be routed to destination Destination 1 with the DPC set to Destination 1 Destination 1 would need to be configured as SVI STP resource Des...

Page 40: ...on in the MTP Routing as enough information has been supplied As before it would be expected that Destination 1 would be configured in the SVI STP as Destination Resource Linkset and DPC Ep name ETSI ROUTING MTPMatch dpc 8887 destination 123 linkset Linkset 1 Ep This would then be routed to destination 123 with the DPC set to 123 and would be sent on Linkset 1 There is no need of any configuration...

Page 41: ...on SP1 ETSI priority 1 weight 1 linkset STP0 STP TST 2 ETSI Routeset RouteEp 5 4 2 3 Weighted This is done using the RouteEp Element and the idea is that if two or more Routes have differing weighting then the distribution on the outbound linksets would reflect this weighting RouteEp name Route 1 Routeset Route destination SP1 ETSI priority 1 weight 3 linkset STP0 STP TST 1 ETSI Route destination ...

Page 42: ...tion SP4 ETSI priority 2 weight 2 linkset STP0 STP TST 3 ETSI Route destination SP1 ETSI priority 3 weight 1 linkset STP0 STP TST 4 ETSI Route destination SP1 ETSI priority 4 weight 1 linkset STP0 STP TST 5 ETSI Routeset RouteEp This would attempt to loadshare across the first two elements if they are available Otherwise it would perform weighted loadsharing across the next three elements if they ...

Page 43: ... received from an external application The API server name must match a API resource configured in the STP main configuration if not configured then the configuration will not accepted by the SVI STP For Example The configuration of this could be that based on the SCCP called party a message received from STP 1 could be routed to either API Server 1 API Server 2 STP 2 If a message is routed to API...

Page 44: ...ge 44 of 57 o The API server for example is checking the MSISDN contained in the Send Routing Info and either return a message LS ETSI OPC 8000 DPC 7100 if the SCCP Called address matches or LS ETSI OPC 8000 DPC 7200 if the Map operating is Send Routing Info ...

Page 45: ...e incoming DPC and the outgoing OPC The CommandList will also inform the SSME of which values will need translating e g SCCP Called SCCP Calling Party Numbers 7 1 Overview When the STP SSME is requested to find Global Title translations it will traverse the entry points set for the incoming linkset global translations to looking for the best match If a best match is discovered then the STP SSME wi...

Page 46: ... will either be present as a sub element of a Command Node or as a sub element of an EntryPoint Node pointed to the Command Node attribute jump These elements will contain the information about the Global Title to be matched and the Global Title Translation to be performed on the relevant match the best match will be used by the SSME The GTT match will be matching against attribute contained an SC...

Page 47: ...this example the address translation will occur on the called and calling SCCP address To only change the Called Party Number then the following would be used CommandList address Called ic DestinationPoint STP MP CPC ETSI routed OriginatingPoint STP 0 ETSI OPC 10001 Command jump Etsi Translation 1 mode GttTranslation CommandList There are two difference translations occurring for different incomin...

Page 48: ...Perform number translation This example shows how to convert a more complex number for example digits 128 with 32 change the translation type if it is 13 to 10 setting the Subsystem to 4 and set the routing indicator to RouteOnGT This will be shown in two different ways Ep name Etsi Translation 1 GTTMatch digits 128 og strip 3 og prefixDigits 32 og ri RouteOnGT ssn 4 GTTMatch digits 128 tt 13 og t...

Page 49: ... the STP SSME XML engine tries To print the summary debug deselect all options on the ssmdebug attribute on the XML resource This will only print out the lines which were matched and selected 8 3 Debug PCAP Configuration In the SVI under Configuration Resources Debug the following configuration options are available To enable the PCAP file set STP Pcap Options to Routed 8 4 XML Configuration To en...

Page 50: ...t The sub element Input contains the information that is required to test a specific path in the SSME xml this can contain the following information ic mtp xxx where xxx is the dpc opc or ni ic sccp xxx where xxx is the sccp information such as called party number calling party number information tcap opCode the TCAP operation to be simulated map cnts the map expression to be tested 9 3 Expected O...

Page 51: ...If any of the Output does not match the ExpectedOutput then the test will fail Other sub elements include DestinationOOS which sets the destination to be considered out of service for the test LinksetOOS which sets the linkset to be considered out of service for the test ...

Page 52: ...uteOnGT ssmeResult Route Test The epname must match the endpoint which is under test and the expected output is set to match the incoming values Now if the DestinatonOOS element is used to as well the following can be performed Test epname instance 3 gtt selector 3E164 name MLR Test 2951 DestinationOOS 11500 DestinationOOS Input ic sccp cdpn digits 0690 ExpectedOutput og sccp cdpn ri RouteOnGT ssm...

Page 53: ...STP SSME using the API Server 6 The Python development kit can be used to create applications such as ANSI LNP CNAME MNP applications SOAP Clients Firewalls for ATI and SRI And many more The purpose of this in conjunction with the API Server routing is that the developer can configure that certain inbound messages to the STP can be routed to the external Application and user specified service logi...

Page 54: ...he XSD file to confirm that it is well formatted It will pass the XML file to the SVI STP this will again validate the XML file checking that the resources references exist within the SVI STP Once the XML file has been validated against the SVI STP the user then has the options to run test XML elements before setting it to a live configuration If selecting the running tests then the tests will be ...

Page 55: ...Confidential Document Page 55 of 57 11 2 Load XML File Create a new resource for the XML and add the following information The File name should match the location of the XML file to be loaded Default location should be home squire ssme ...

Page 56: ... the information has been entered select the Configure option this will load the following screen Select file allows the user to select the file they will to load into the SVI STP Configure allows the user to Run Tests Validate validate the selected file against the XSD File ...

Page 57: ...nologies Confidential Document Page 57 of 57 11 3 Configure Linkset Using the Wizard MTP Layer 3 Linkset A link or MTP Layer 3 Linkset F link wizard For SUA this configuration setting will be on the Sigtran SCTP Socket wizard ...

Reviews:

No comments

Related manuals for SVI STP SSME

Brand: GE Pages: 3

Brand: GE Pages: 124

Brand: Dinstar Pages: 41

PagePro VIP-204A

Brand: Valcom Pages: 4

Brand: Iget Pages: 8

KoolKey EKA 200

Brand: Danfoss Pages: 2

Brand: D-Link Pages: 83

Brand: Xtreme Pages: 2

Brand: Meraki Pages: 11

Brand: Funkwerk Pages: 594

Brand: Kaon Pages: 5

Brand: Planet Networking & Communication Pages: 235

Brand: ZyXEL Communications Pages: 505

Brand: Appareo Pages: 9

Brand: Kinnex Pages: 26

Brand: Arris Pages: 116

Brand: 2N Telekomunikace Pages: 105

Brand: 4IPNET Pages: 368

Brands by name

0 1 2 3 4 5 6 7 8 9 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Popular brands

Load more brands