StarQuality SOAP Interface Ver.2.0, Reference Guide
Contents
1. 1 1 LER ls NOS rc 1 a General Func DOTIE EI dx Mex PRA CAREER ERU PP p dep ERA ax kikit a d pia 2 4 1 Authentication e 2 4 2 Defining Output Characteristics nennen 3 5 Selected Objects and Operations 4 el ipid e kk ki ik kk 4 5 2 GenerlcEquipmient sis sanke tape dok sik cantante bek PR x PE cM Ra ka RR ER 4 SNO Puget emm 4 5 2 2 Operations ListEquipments CER ERU P RR EAE KNIE PE 5 5 2 Measurements iiri ki ia an oHG UP iO e Ud auda i Gioia atn EH UU b FD a 6 1 Object Attribute Skeneriai alee 6 5 3 2 Operations 5 2 7 NAR 8 61 Obj t Attributes 8 6 2 Operations getMeasuredValues 8 2 Performing SOAP Queries vis vi bi kk wk ka kk kk kk a ak kaa kk e l e iii 9 7 41 TORO GUC MON ii kila kk l kk ke e a Ok a a kk kk kk a 9 7 2 Quering a Specific Measurement for Specific Equipment2. 9 SOAP Interface for StarQuality o Reference Guide Contents 8 Appendix DescriptionToS5how 29 10 8 1 EDD ATIDD A Uit Saa kab ann 10 8 2 il dicic ka kk 11 8 3 FDD SU fer c 14 BA TOU SU e 14 8 3 4 MOU ON SU e ki rn n a ka e ki a ee e S 15 9 Abbreviations and cues deside kas pasan iori ren Eo ris 15 SOAP Interface for StarQuality Reference Guide Tables Tables Table 1 Authentication Mee 2 Table 2 Parameters for Defining Output 3 Table 3 GenericEquipment Object 4 Table 4 Operations 5 Table 5 Measurements Object 6 Table 6 Operations ListMeasurements 7 Table 7 GetMeasuredValuesInput Object 8 Table 8 Operations 8 Table 9 listEquipments D OO nan eee pate E 9 Table 10 listMeasurements oeil rai ban kl o
3. o Your Open WiMAX Choice SOAP Interface for StarQuality Reference Guide Software Version 2 0 September 2009 P N 215402 Legal Rights Legal Rights Copyright 2009 Alvarion Ltd All rights reserved The material contained herein is proprietary privileged and confidential and owned by Alvarion or its third party licensors No disclosure thereof shall be made to third parties without the express written permission of Alvarion Ltd Alvarion Ltd reserves the right to alter the equipment specifications and descriptions in this publication without prior notice No part of this publication shall be deemed to be part of any contract or warranty unless specifically incorporated by reference into such contract or warranty Trade Names Alvarion BreezeCOM WALKair WALKnet BreezeNET BreezeACCESS BreezeLINK BreezeMAX BreezeLITE BreezePHONE 4MOTION BreezeCONFIG MGW eMGW and or other products and or services referenced here in are either registered trademarks trademarks or service marks of Alvarion Ltd All other names are or may be the trademarks of their respective owners WiMAX Forum is a registered trademark of the WiMAX Forum WiMAX the WiMAX Forum logo WiMAX Forum Certified and the WiMAX Forum Certified logo are trademarks of the WiMAX Forum Statement of Conditions The information contained in this manual is subject to change without notice
4. The specifications on which they are based are subject to change without notice The software described in this document is furnished under a license The software may be used or copied only in accordance with the terms of that license Information in this document is subject to change without notice Corporate and individual names and data used in examples herein are fictitious unless otherwise noted Alvarion Ltd reserves the right to alter the equipment specifications and descriptions in this publication without prior notice No part of this publication shall be deemed to be part of any contract or warranty unless specifically incorporated by reference into such contract or warranty The information contained herein is merely descriptive in nature and does not constitute an offer for the sale of the product described herein Any changes or modifications of equipment including opening of the equipment not expressly approved by Alvarion Ltd will void equipment warranty and any repair thereafter shall be charged for It could also void the user s authority to operate the equipment SOAP Interface for StarQuality o Reference Guide About this Manual About this Manual This document describes the obtaining of a specific measurement value for a specific device This is actually only a part of the SOAP support described in a larger document SOAP Interface for StarQuality o Reference Guide Contents Contents T gt
5. Alvarion Ltd shall not be liable for errors contained herein or for incidental or consequential damages in connection with the furnishing performance or use of this manual or equipment supplied with it Warranties and Disclaimers All Alvarion Ltd Alvarion products purchased from Alvarion or through any of Alvarion s authorized resellers are subject to the following warranty and product liability terms and conditions Exclusive Warranty a Alvarion warrants that the Product hardware it supplies and the tangible media on which any software is installed under normal use and conditions will be free from significant defects in materials and workmanship for a period of fourteen 14 months from the date of shipment of a given Product to Purchaser the Warranty Period Alvarion will at its sole option and as Purchaser s sole SOAP Interface for StarQuality o Reference Guide Legal Rights remedy repair or replace any defective Product in accordance with Alvarion standard R amp R procedure b With respect to the Firmware Alvarion warrants the correct functionality according to the attached documentation for a period of fourteen 14 month from invoice date the Warranty Period During the Warranty Period Alvarion may release to its Customers firmware updates which include additional performance improvements and or bug fixes upon availability the Warranty Bug fixes temporary patches and or workaround
6. SYSTEMS IN HAZARDOUS ENVIRONMENTS REQUIRING FAIL SAFE PERFORMANCE SUCH AS IN THE OPERATION OF NUCLEAR FACILITIES AIRCRAFT NAVIGATION OR COMMUNICATION SYSTEMS AIR TRAFFIC CONTROL LIFE SUPPORT MACHINES WEAPONS SYSTEMS OR OTHER APPLICATIONS REPRESENTING A SIMILAR DEGREE OF POTENTIAL HAZARD ALVARION SPECIFICALLY DISCLAIMS ANY EXPRESS OR IMPLIED WARRANTY OF FITNESS FOR HIGH RISK ACTIVITIES SOAP Interface for StarQuality Reference Guide Legal Rights b PURCHASER S SOLE REMEDY FOR BREACH OF THE EXPRESS WARRANTIES ABOVE SHALL BE REPLACEMENT OR REFUND OF THE PURCHASE PRICE AS SPECIFIED ABOVE AT ALVARION S OPTION TO THE FULLEST EXTENT ALLOWED BY LAW THE WARRANTIES AND REMEDIES SET FORTH IN THIS AGREEMENT ARE EXCLUSIVE AND IN LIEU OF ALL OTHER WARRANTIES OR CONDITIONS EXPRESS OR IMPLIED EITHER IN FACT OR BY OPERATION OF LAW STATUTORY OR OTHERWISE INCLUDING BUT NOT LIMITED TO WARRANTIES TERMS OR CONDITIONS OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE SATISFACTORY QUALITY CORRESPONDENCE WITH DESCRIPTION NON INFRINGEMENT AND ACCURACY OF INFORMATION GENERATED ALL OF WHICH ARE EXPRESSLY DISCLAIMED ALVARION WARRANTIES HEREIN RUN ONLY TO PURCHASER AND ARE NOT EXTENDED TO ANY THIRD PARTIES ALVARION NEITHER ASSUMES NOR AUTHORIZES ANY OTHER PERSON TO ASSUME FOR IT ANY OTHER LIABILITY IN CONNECTION WITH THE SALE INSTALLATION MAINTENANCE OR USE OF ITS PRODUCTS Limitation of Liability a ALVARION SHALL NOT BE LIABLE TO THE
7. The following lists detail WiMAX measurement names DescriptionToShow values according to equipment type 8 1 FDD TDD AU Each string should be headed by the required Slot number according to the required AU Example Slot 3 Air Link Utilization SOAP Interface for StarQuality Reference Guide Air Link Utilization CIR Allocated MIR CIR Allocated Number Of Connected SUs FDD TDD AU Appendix DescriptionToShow Values 4Motion BS B Subscription B Throughput H Total Used Capacity Rate 1 BPSK 1 2 H Total Used Capacity Rate 2 BPSK 3 4 E Total Used Capacity Rate QPSK 1 2 H Total Used Capacity Rate 4 QPSK 3 4 Total Used Capacity Rate 5 16QAM 1 2 Total Used Capacity Rate 6 16QAM 3 4 H Total Used Capacity Rate 7 64QAM 2 3 H Total Used Capacity Rate 8 64QAM 3 4 8 2 4 BS Each string should be headed by required bs name as it appears in StarQuality system Example BS 9 9 9 Air Link Utilization All Average Sector Throughput Average Spectral Efficiency all MSs H DL Air Link Utilization Data Zone H DL Air Link Utilization Map Zone H UL Air Link Utilization Data Zone B UL Air Link Utilization Feedback Zone Air Link Utilization All B DL Retransmission Zero Retransmission SOAP Interface for StarQuality an Reference Guide Appendix DescriptionToShow Values 4Motion BS B DL Retransmission One Retransmission B DL Retransmission Two R
8. than the CGI based interface creation of a new process is unnecessary and all the meta data is already loaded The authentication is based on the Authentication part of the SOAP Header which contains the username and password The authentication is based on the same Authentication part of the SOAP Header even when the request is received through the Web The SOAP requests are independent every request creates a new transaction This means that a modification made through the SOAP interface is immediately executed in the database except when some error have occurred in which case the whole transaction is rolled back 3 WSDL File The StarQuality Web Services Description Language WSDL document PVSR WSDL can be obtained as follows SOAP Interface for StarQuality o Reference Guide General Functionality Authentication B Downloaded from the StarQuality server from the URL http name of the server cgi bin soap web pl WSDL Ina StarQuality installation it can be found in the path opt StarQuality etc The NBI WSDL includes the URL by which to access the service and Web service In order to make the WSDL file suitable for your specific environment the following WSDL elements appearing at the end of the document must be modified wsdl service name PerformanceVisor lt wsdl port name PerformanceVisorSoap binding tns PerformanceVisorSoap gt lt soap address location http localhost 8082 gt lt
9. wsdl port gt lt wsdl service gt Open the PVSR WSDL file using a text editor and replace the string localhost with the IP address of your StarQuality server machine If the SOAP interface default port was changed from the default setting of 8082 Refer to the StarQuality User Manual change the port setting in the URL accordingly General Functionality Authentication The StarQuality SOAP server authentication is based on the authentication part of the SOAP Header which contains a username and password The username and password should be those of a user registered in the StarQuality server and with the required authorizations to view data regarding the inquired equipments or measurements Table 1 Authentication Parameter Description Remark Username String complying to a StarQuality user Mandatory Password String complying to a StarQuality user Mandatory SOAP Interface for StarQuality o Reference Guide General Functionality Defining Output Characteristics Example sO Authentication xsi type sO Authentication xmlns soapenc http schemas xmlsoap org soap encoding xmlns xs http www w3 0rg 2001 XMLSchema xmlns xsi http www w3 org 2001 XMLSchema instance xmlns s0 PVSR 5 gt s0 Username xsi type xs string gt admin lt s0 Username gt s0 Password xsi type xs string admin123 s0 Password lt s0 Authentication gt 4 2 Defining Output Characteristics Each S
10. 16QAM 1 2 B MCS Distribution 16QAM 3 4 B MCS Distribution 64QAM 1 2 B MCS Distribution 64QAM 2 3 B MCS Distribution 64QAM 3 4 B MCS Distribution 64QAM 5 6 B MCS Distribution QPSK 1 2 SOAP Interface for StarQuality o Reference Guide Appendix DescriptionToShow Values MCS Distribution QPSK 1 2 Rep 2 MCS Distribution QPSK 1 2 Rep 4 MCS Distribution QPSK 1 2 Rep 6 MCS Distribution QPSK 3 4 Max Spectral Efficiency all MSs Number Of Connected SUs UL Noise 99th Percentile UL Noise Median 8 3 FDD TFTP SU SU RATE AVERAGE SU RATE MAX SU RATE MIN SU RSSI AVERAGE SU RSSI MAX SU RSSI MIN SU SNR AVERAGE SU SNR MAX SU SNR MIN 8 4 TDD SU SU RATE AVERAGE SU RATE MAX SOAP Interface for StarQuality o FDD TFTP SU Reference Guide Abbreviations and Terms 8 5 SU RATE MIN SU RSSI AVERAGE SU SNR MAX SU SNR AVERAGE SU SNR MIN 4Motion SU Abbreviations and Terms CINR Downlink CINR Uplink MCS Downlink MCS Uplink RSSI Uplink Average Spectral Efficiency Table 12 Abbreviations and Terms 4Motion SU Item Description ACS Automatic configuration server BS Base station either BS SH or uBS DHCP of IP addresses Dynamic Host Configuration Protocol A protocol that is used for the dynamic allocation Internet Protocol LAN Local Area Network uBS Micro Base Station NPU Network Processing Uni
11. 8 37 000Z to time 2009 06 14T08 58 29 384Z Envelope xmlns soapenv http schemas xmlsoap org soap envelope soapenv Header sO Authentication xsi type s0 Authentication xmlns soapenc http schemas xmlsoap org soap encoding xmlns xs http www w3 org 2001 XMLSchema xmlns xsi http www w3 org 2001 XMLSchema instance xmlns s0 PVSR_SOAP gt s0 Username xsi type xs string gt admin lt s0 Username gt s0 Password xsi type xs string admin123 s0 Password s0 Authentication SOAP Interface for StarQuality Reference Guide Performing SOAP Queries Introduction lt gt lt soapenv Body soapenv encodingStyle http schemas xmlsoap org soap encoding gt s0 getMeasuredValues xmlns soapenc http schemas xmlsoap org soap encoding xmlns xs http www w3 org 2001 XMLSchema xmlns xsi http www w3 org 2001 XMLSchema instance xmlns s0 PVSR 5 gt input xsi type s0 GetMeasuredValuesInput s0 0bjType xsi type s0 MeasuredValuesType Measurement s0 ObjType s0 0bjId xsi type xs long 5543 s0 0bjId s0 From xsi type xs dateTime gt 2009 06 13T11 58 37 0002Z lt s0 From gt s0 To xsi type xs dateTime gt 2009 06 14T08 58 29 384Z lt s0 To gt lt input gt lt s0 getMeasuredValues gt lt gt soapenv Envelope 7 Performing SOAP Queries 7 1 Introduction Due to the generic
12. OAP query includes definitions as to the characteristics of the output list These definitions include the following Table 2 Parameters for Defining Output Characteristics Parameter Description Remark Maxsize Max value of output result list Use maxsize 0 for unlimited list size addToWhere Example lt soapenv Body soapenv encodingStyle http schemas xmlsoap org soap encoding gt s0 listMeasurements xmlns soapenc http schemas xmlsoap org soap encoding xmlns xs http www w3 org 2001 XMLSchema xmlns xsi http www w3 org 2001 XMLSchema instance xmlns s0 PVSR SOAP filter xsi type s0 Measurement gt s0 Id xsi type xs long xsi nil true gt lt 50 xsi type xs string xsi nil true gt s0 Index xsi type xs string xsi nil true sO ParentId xsi type xs long gt 61 lt s0 ParentId gt sO DescriptionToShow xsi type xs string xsi nil true sO Description xsi type xs string xsi nil true gt s0 Switched xsi type s0 YesNoType xsi nil true gt s0 RetainRawData xsi type xs long xsi nil true gt sO IntervalInSec xsi type xs long xsi nil true s0 Peak xsi type s0 MeasurementPeakType xsi nil true gt s0 MaxPercent xsi type xs long xsi nil true gt s0 Multiplier xsi type xs long xsi nil true gt s0 Remark xsi type xs string xsi nil true gt lt filter gt lt maxsize x
13. PURCHASER OR TO ANY THIRD PARTY FOR ANY LOSS OF PROFITS LOSS OF USE INTERRUPTION OF BUSINESS OR FOR ANY INDIRECT SPECIAL INCIDENTAL PUNITIVE OR CONSEQUENTIAL DAMAGES OF ANY KIND WHETHER ARISING UNDER BREACH OF CONTRACT TORT INCLUDING NEGLIGENCE STRICT LIABILITY OR OTHERWISE AND WHETHER BASED ON THIS AGREEMENT OR OTHERWISE EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES b TO THE EXTENT PERMITTED BY APPLICABLE LAW IN NO EVENT SHALL THE LIABILITY FOR DAMAGES HEREUNDER OF ALVARION OR ITS EMPLOYEES OR AGENTS EXCEED THE PURCHASE PRICE PAID FOR THE PRODUCT BY PURCHASER NOR SHALL THE AGGREGATE LIABILITY FOR DAMAGES TO ALL PARTIES REGARDING ANY PRODUCT EXCEED THE PURCHASE PRICE PAID FOR THAT PRODUCT BY THAT PARTY EXCEPT IN THE CASE OF A BREACH OF A PARTY S CONFIDENTIALITY OBLIGATIONS SOAP Interface for StarQuality o Reference Guide Important Notice Important Notice This user manual is delivered subject to the following conditions and restrictions This manual contains proprietary information belonging to Alvarion Ltd Such information is supplied solely for the purpose of assisting properly authorized users of the respective Alvarion products No part of its contents may be used for any other purpose disclosed to any person or firm or reproduced by any means electronic and mechanical without the express prior written permission of Alvarion Ltd The text and graphics are for the purpose of illustration and reference only
14. characteristic of the objects and methods in the SOAP interface the most required operations should be performed in several steps 7 2 Quering a Specific Measurement for Specific Equipment 1 Stepl listEquipments Table 9 listEquipments Input data GenericEquipment object with a single parameter Examples Required equipment name as it is set and is unique SU SU in StarQuality system and viewable in the GUI 00 10 E7 62 1E 96 BTS 10 10 184 1 Output data A list of GenericEquipment objects with one member relevant attribute ID 2 Step2 listMeasurements SOAP Interface for StarQuality o Reference Guide Appendix DescriptionToShow Values Table 10 listMeasurements Input data Measurement object with 2 parameters E Parentld use the Id retrieved step 1 DescriptionToShow according to equipment type choose from the values detailed in appendix A Output data A list of measurement objects with a single member Relevant attribute ID 3 Step3 getMeasuredValues Table 11 getMeasuredValues Input data getMeasuredValuesinput with the following parameters Objld use the ld retrieved in step 2 E From start date E To end date Output data List of measured values Length of list is according to the time span selected value per 15 minutes 8 Appendix DescriptionToShow Values DescriptionToShow values for WiMAX Equipment
15. chema instance 50 5 5 gt filter xsi type s0 GenericEquipment gt s0 lt 50 50 lt 50 50 SO 50 lt 50 lt 50 80 s0 lt 0 605 lt s0 850 lt 50 Id xsi type xs long xsi nil true gt Name xsi type xs string gt 10 10 182 201 lt s0 Name gt CollectorType xsi type xs string xsi nil true gt ParentId xsi type xs long xsi nil true gt Description xsi type xs string xsi nil true gt Uptime xsi type xs string xsi nil true RetainRawData xsi type xs long xsi nil true CreatedBy xsi type xs string xsi nil true gt CreatedTs xsi type xs dateTime xsi nil true gt LastModBy xsi type xs string xsi nil true gt LastModTs xsi type xs dateTime xsi nil true gt IntervallnSec xsi type xs long xsi nil true Icon xsi type xs string xsi nil true CollectorGroup xsi type xs long xsi nil true gt CollectorMember xsi type xs long xsi nil true gt PreviousCollectorMember xsi type xs long xsi nil true gt SOAP Interface for StarQuality O Reference Guide Selected Objects and Operations Measurements s0 CollectorChgTs xsi type xs dateTime xsi nil true s0 CollectData xsi type s0 YesNoType xsi nil true lt filter gt lt maxsize xsi type xs long gt 0 lt maxsize gt add lt sO list lt gt soa
16. es No No No PreviousCollectorMember xsd long 10 Yes No No No CollectorChgTs xsd dateTime Yes No No No CollectData YesNoType Yes Yes Yes No Yes SOAP Interface for StarQuality Reference Guide Selected Objects and Operations GenericEquipment 5 2 2 Operations ListEquipments Table 4 Operations ListEquipments Input parameters filter GenericEquipment maxsize xsd long addToWhere xsd string Output parameters list GenericEquipments The following example will return an unlimited sized list of equipments answering to a single filter criterion of equipment name 10 10 182 201 lt soapenv Envelope xmlns soapenv http schemas xmlsoap org soap envelope gt lt soapenv gt sO Authentication xsi type sO Authentication xmlns xmlns xmlns xmlns soapenc http schemas xmlsoap org soap encoding xs http www w3 org 2001 XMLSchema xsi http www w3 org 2001 XMLSchema instance S0 PVSR 5 gt s0 Username xsi type xs string gt admin lt s0 Username gt s0 Password xsi type xs string admin123 s0 Password lt s0 Authentication gt lt soapenv Header gt lt soapenv Body soapenv encodingStyle http schemas xmlsoap org soap encoding gt s0 listEquipments xmins xmins xmins xmins soapenc http schemas xmlsoap org soap encoding xs http www w3 org 2001 XMLSchema xsi http www w3 org 2001 XMLS
17. etransmissions B DL Retransmission Three Retransmissions B DL Retransmission Four Retransmissions B DL Retransmission Above Four Retransmissions B DL SINR Distribution SINR 5dB B DL SINR Distribution SINR 5dB till 9dB DL SINR Distribution SINR 11dB till 13dB B DL SINR Distribution SINR 15dB till 17dB B DL SINR Distribution SINR 19dB till 21dB B DL SINR Distribution SINR 23dB till 25dB B UL SINR Distribution SINR 13dB till 17dB B UL SINR Distribution SINR 17dB till 21dB B UL SINR Distribution SINR 5dB till 9dB B UL SINR Distribution SINR 9dB till 13dB B UL SINR Distribution SINR lt 5dB UL SINR Distribution SINR gt 21dB HARQ Packet Error Rate PER 16QAM 1 2 HARQ Packet Error Rate PER 16QAM 3 4 HARQ Packet Error Rate PER 64QAM 1 2 HARQ Packet Error Rate PER 64QAM 2 3 SOAP Interface for StarQuality o Reference Guide Appendix DescriptionToShow Values 4Motion BS HARQ Packet Error Rate PER 64QAM 3 4 B Packet Error Rate PER 64QAM 5 6 HARQ Packet Error Rate PER QPSK 1 2 HARQ Packet Error Rate PER QPSK 1 2 Rep 2 HARQ Packet Error Rate PER QPSK 1 2 Rep 4 HARQ Packet Error Rate PER QPSK 1 2 Rep 6 HARQ Packet Error Rate PER QPSK 3 4 B HARQ Packet Error Rate Percent MAP Length Two Symbols B MAP Length Four Symbols MAP Length Six Symbols MAP Length Eight Symbols MAP Length Ten Symbols MAP Length More Than Ten Symbols B MCS Distribution
18. i type xs long xsi nil true gt sO Multiplier xsi type xs long xsi nil true gt s0 Remark xsi type xs string xsi nil true gt filter gt lt maxsize xsi type xs long gt 5 lt maxsize gt lt addToWhere xsi type xs string gt lt s0 listMeasurements gt soapenv Body lt soapenv Envelope gt SOAP Interface for StarQuality o Reference Guide GetMeasuredValuesinput Object Attributes 6 6 1 GetMeasuredValuesinput This object is used to pass the required parameters to the various GetMeasurement values operations Object Attributes Table 7 GetMeasuredValuesinput Object Attrubutes Name Type Objld xsd long From xsd dateTime To xsd dateTime 6 2 Operations getMeasuredValues This method returns the measured values for a specific measurement similar to the Export to XLS functionality on the GUI The MeasuredValues object contains a ColumnCount attribute which determines the number of values in the array that follows it For large amounts of data the usage of the bulk export GUI utility is recommended rather than SOAP operation refer to the StarQuality User Manual Table 8 Operations getMeasuredValues Input parameters input GetMeasuredValuesinput Output parameters list MeasuredValues soapenv The following example returns an unlimited list of results for measurement with ID 543 from time 2009 06 13T11 5
19. ka da ki pi si dat n a tj 10 Table 11 10 Table 12 Abbreviations and iieri etia ek e eki ke eate kn RR n ERR pena ape 15 SOAP Interface for StarQuality o Reference Guide Introduction 1 Introduction The StarQuality SOAP Northbound Interface NBI provides the means of extracting measurement data from the StarQuality Database by an upper level management system OSS or any relevant application The upper level management system issues requests to StarQuality via the NBI and the StarQuality server processes these requests and communicates the results The NBI is based on Web Services with XML SOAP supporting multiple simultaneous requests This document describes the obtaining of a specific measurement value for a specific device This is actually only a part of the SOAP support described in a larger document 2 Sending SOAP Requests StarQuality is able to receive a SOAP request in two ways B Through the separate server module SOAP server B Through the Web using a specific CGI script The SOAP server listens on the TCP port 8082 by default This port can be changed in the configuration file using the 5 LISTEN PORT parameter The server splits a new sub process for every established connection so the concurrent sessions do not block each other As a result the use of the SOAP server is faster
20. ment parent id 61 lt soapenv Envelope xmlns soapenv http schemas xmlsoap org soap envelope gt lt soapenv gt s0 Authentication xsi type sO Authentication xmlns soapenc http schemas xmlsoap org soap encoding xmlns xs http www w3 org 2001 XMLSchema xmlns xsi http www w3 org 2001 XMLSchema instance xmlns s0 PVSR SOAP sO Username xsi type xs string gt admin lt s0 Username gt s0 Password xsi type xs string admin123 s0 Password s0 Authentication soapenv Header soapenv Body soapenv encodingStyle http schemas xmlsoap org soap encoding s0 listMeasurements xmlns soapenc http schemas xmlsoap org soap encoding xmlns xs http www w3 org 2001 XMLSchema xmlns xsi http www w3 org 2001 XMLSchema instance xmlns s0 PVSR 5 gt filter xsi type s0 Measurement gt s0 Id xsi type xs long xsi nil true lt 0 xsi type xs string xsi nil true s0 Index xsi type xs string xsi nil true gt sO ParentId xsi type xs long gt 61 lt s0 ParentId gt lt s0 DescriptionToShow xsi type xs string xsi nil true gt s0 Description xsi type xs string xsi nil true gt s0 Switched xsi type s0 YesNoType xsi nil true sO RetainRawData xsi type xs long xsi nil true sO IntervalInSec xsi type xs long xsi nil true gt lt 50 xsi type s0 MeasurementPeakType xsi nil true gt s0 MaxPercent xs
21. penv Envelope 5 3 The measurement object represents the generic StarQuality measurements Measurements ToWhere xsi type xs string Equipments gt i gt F 5 3 1 Object Attributes Table 5 Measurements Object Attributes Name Type Length Search Creation Modification Deletion Default value Id xsd long 10 Yes No Key Yes Type xsd string 5 Yes Mandatory No No Index xsd string 1000 Yes Mandatory Mandatory No Parentld xsd long 10 Order Mandatory No No DescriptionToShow xsd string 3000 Order Mandatory Mandatory No Description xsd string 3000 Yes Yes Yes No Switched YesNoType Yes Yes Yes No No RetainRawData xsd long 5 Yes Yes Yes No IntervallnSec xsd long 5 Yes Mandatory Yes No Peak Measurement Yes Yes Yes No PeakType MaxPercent xsd long 3 Yes Yes Yes No Multiplier xsd long 10 Yes Yes Yes No Remark xsd string 255 Yes Yes Yes No Parameter Parameter No Yes Yes No array SOAP Interface for StarQuality Reference Guide Selected Objects and Operations Measurements 5 3 2 Operations ListMeasurements Table 6 Operations ListMeasurements Input parameters filter Measurement maxsize xsd long addToWhere xsd string Output parameters list Measurements The following example will return a result list up to 5 members long of the existing measurements according to a single filtering criterion of equip
22. s may be supplied as Firmware updates Additional hardware if required to install or use Firmware updates must be purchased by the Customer Alvarion will be obligated to support solely the two 2 most recent Software major releases ALVARION SHALL NOT BE LIABLE UNDER THIS WARRANTY IF ITS TESTING AND EXAMINATION DISCLOSE THAT THE ALLEGED DEFECT IN THE PRODUCT DOES NOT EXIST OR WAS CAUSED BY PURCHASER S OR ANY THIRD PERSON S MISUSE NEGLIGENCE IMPROPER INSTALLATION OR IMPROPER TESTING UNAUTHORIZED ATTEMPTS TO REPAIR OR ANY OTHER CAUSE BEYOND THE RANGE OF THE INTENDED USE OR BY ACCIDENT FIRE LIGHTNING OR OTHER HAZARD Disclaimer a The Software is sold on an AS IS basis Alvarion its affiliates or its licensors MAKE NO WARRANTIES WHATSOEVER WHETHER EXPRESS OR IMPLIED WITH RESPECT TO THE SOFTWARE AND THE ACCOMPANYING DOCUMENTATION ALVARION SPECIFICALLY DISCLAIMS ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT WITH RESPECT TO THE SOFTWARE UNITS OF PRODUCT INCLUDING ALL THE SOFTWARE DELIVERED TO PURCHASER HEREUNDER ARE NOT FAULT TOLERANT AND ARE NOT DESIGNED MANUFACTURED OR INTENDED FOR USE OR RESALE IN APPLICATIONS WHERE THE FAILURE MALFUNCTION OR INACCURACY OF PRODUCTS CARRIES A RISK OF DEATH OR BODILY INJURY OR SEVERE PHYSICAL OR ENVIRONMENTAL DAMAGE HIGH RISK ACTIVITIES HIGH RISK ACTIVITIES MAY INCLUDE BUT ARE NOT LIMITED TO USE AS PART OF ON LINE CONTROL
23. si type xs long gt 5 lt maxsize gt lt addToWhere xsi type xs string gt lt s0 listMeasurements gt lt soapenv gt SOAP Interface for StarQuality Reference Guide Selected Objects and Operations Selected Objects and Operations Introduction 5d Introduction The StarQuality SOAP interface includes various generic object types and operations This section details selected objects and operations which can be used in order to perform the required data collecting operations 5 2 The GenericEquipment object and its inherited types represent every collector type in the StarQuality system 5 2 1 Object Attributes Table 3 GenericEquipment Object Attributes Name Type Length Search Creation Modification Deletion Default value Id xsd long 10 Yes No Key Yes Name xsd string 50 Order Mandatory Mandatory No CollectorType xsd string 1 Yes Mandatory No No Parentld xsd long 10 Yes Mandatory Mandatory No Description xsd string 50 Yes Yes Yes No Uptime xsd string 50 Yes No No No RetainRawData xsd long 10 Yes Yes Yes No CreatedBy xsd string 30 Yes No No No CreatedTs xsd dateTime Yes No No No LastModBy xsd string 30 Yes No No No LastModTs xsd dateTime Yes No No No IntervallnSec xsd long 10 Yes Yes Yes No 300 Icon xsd string 250 Yes Yes Yes No icon_equip png CollectorGroup xsd long 10 Yes Yes Yes No CollectorMember xsd long 10 Y
24. t RF Radio Frequency SOAP Interface for StarQuality Reference Guide Abbreviations and Terms 4Motion SU Table 12 Abbreviations and Terms Item Description SU BreezeMAX Subscriber Unit SW Software refers to the Firmware version of the units SOAP Interface for StarQuality Reference Guide
Download Pdf Manuals
Related Search