Inmagic Web Services Guide
Contents
1. password with which to open the textbase If null no password is passed in Returns textbase resulttype log fields and status succeeded failed for each record submitted also contains error information Page 4 Inmagic Proprietary and Confidential The SOAP Interface update Parameters lt textbase gt _recordsettypeRecord array of records to be modified in the textbase string array containing the names of log fields to be returned in the confirmation response string password with which to open the textbase If null no password is passed in Returns textbase resulttype log fields and status succeeded failed amended for each record submitted also contains error information delete Parameters lt textbase gt _recordsettypeRecord array of records to be deleted from the textbase string array containing the names of log fields to be returned in the confirmation response string password with which to open the textbase If null no password is passed in Returns textbase resulttype log fields and status succeeded failed for each record submitted also contains error information qdelete Parameters string query string in command query format for example Find Author CT Smith all records found by this query will be deleted string array containing the names of log fields to be returned in the confirmation response string password with2. sess SUCH MOE xi secs t e p ee cre ea Eee ood eta gdelete c sess ee tB SERES NO denies QUEIVDS EE insertDS ie Ee e heads bise et de HI ep ip ERE ERERR updateD 9 5 no oc esu teer Eu ets e ies ee VD els bp EIE gdelete 9 3 e mentior dediti dde XML model Rr teh ve ete bebe hades denen A voids asec qdeleteXz sme e RERO t VERE e EON et oen tre daB Error HANGING EP How to Use the SOAP Interface eeeeseeeeeseeeeeneeeennnnnnnnnnnnn Using the SOAP Interface with Visual Studio NET 2003 T xtbase Design TIInts eee ore iati tac rre ieee TE ese Inmagic Web Services Guide Inmagic Proprietary and Confidential Page iii Page iv Inmagic Proprietary and Confidential Inmagic Web Services Guide Preface This technical guide is intended for developers system integrators and partners of Inmagic Inc who will be using the Inmagic Web services SOAP interface to develop their own applications for use with the Inmagic DB Text product line Note that the Inmagic Web Services SOAP interface is suited for the Microsoft Visual Studio NET 2003 development environment in which it was tested It has not been validated in any other development environments Other Documentation For a list of the documentation available for the Inmagic DB Text product line see the DB TextWorks and WebPublisher PRO README file Contacting Inmagic Inc For help you can contac
3. the request Some examples of problems that would generate a SOAP fault include query syntax errors textbase access problems or operations involving textbase fields that were deleted or renamed after the SOAP interface was created Some examples of errors that would be returned in the response include an attempt to delete a record that does not exist or enter invalid information in a field Page 10 Inmagic Proprietary and Confidential The SOAP Interface How to Use the SOAP Interface This section describes how to use the SOAP interface with Visual Studio NET 2003 Using the SOAP Interface with Visual Studio NET 2003 After you have created the SOAP interface and copied the files to your WebPublisher PRO SOAP subfolder create a Visual Studio NET 2003 project and add a Web reference Navigate to the SOAP subfolder and type the lt textbase gt WSDL filename for example http lt hostname gt dbtw wpd SOAP cars wsd1 Visual Studio NET 2003 will generate a namespace with the name you selected for the Web reference This namespace contains the following classes where lt textbase gt represents your textbase name for example Cars recordset ifyour textbase name is Cars Class Description textbase recordset Dataset containing records Dataset model textbase recordsettypeRecord struct containing records Struct model textbase result dataset containing result of an update insert or delete operation Dataset
4. INMAGIC Web Services Guide Inmagic Proprietary and Confidential Copyright 2004 2005 by Inmagic Inc All rights reserved Inmagic the Inmagic logo DB Text DB TextWorks BiblioTech and BiblioTech PRO are registered trademarks and Inmagic net BibSpeed IntelliMagic and PowerPack are trademarks of Inmagic Inc Other brand and product names are trademarks or registered trademarks of their respective holders The information in this document is subject to change without notice and should not be construed as a commitment by Inmagic Inc which assumes no responsibility for any errors that may appear in this document Use of any other product name does not imply endorsement of that product by Inmagic Inc This documentation may be used only in accordance with the terms of the Inmagic license agreement WARRANTY INMAGIC INC MAKES NO WARRANTY EXPRESS OR IMPLIED INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY AND FITNESS INMAGIC INC SHALL NOT BE LIABLE FOR ANY LOST PROFITS OR ANY OTHER INCIDENTAL OR CONSEQUENTIAL DAMAGES IN PARTICULAR INMAGIC INC SHALL HAVE NO LIABILITY FOR ANY DATA OR PROGRAMS STORED OR USED WITH THIS PRODUCT INCLUDING THE COSTS OF RECOVERING SUCH PROGRAMS OR DATA U S GOVERNMENT If Licensee is acquiring the software on behalf of any unit or agency of the U S Government the following shall apply a For units of the Department of Defense RESTRICTED RIGH
5. TS LEGEND Use duplication or disclosure by the Government is subject to restrictions as set forth in subparagraph c 1 11 of the Rights in Technical Data Clause at DFARS 252 227 7013 b For any other unit or agency NOTICE Notwithstanding any other lease or license agreement that may pertain to or accompanying the delivery of the computer software and accompanying documentation the rights of the Government regarding its use reproduction and disclosure are as set forth in Clause 52 227 19 c 2 of the FAR Contractor Manufacturer is Inmagic Inc 200 Unicorn Park Drive Fourth Floor Woburn MA 01801 U S A Questions regarding any Inmagic product should be addressed to Inmagic Inc or your local authorized Inmagic dealer Inmagic Inc 200 Unicorn Park Drive Fourth Floor Woburn MA 01801 U S A Telephone 781 938 4444 or 800 229 8398 Fax 781 938 4446 http www inmagic com r0505 WPP800 Inmagic Proprietary and Confidential Contents RAA E A PETENDO UIDI UBI Other Documentation eseseeeeeem me m n nnne nennen rsen Contacting Inmaglc Inc o rette tarde ede ene a dees Web Services SOAP Interface eeeeeeeeeeeeeee eene nnn How to Create a SOAP Interface for a Textbase ee The SOAP Interface 5 rri rie a Enn R ane Ya Re YR Ra Ye y ao vx y ERN RENE RR RYE RR ieai Operations as seen in Visual Studio NET 2003
6. ated with the DB TextWorks online help Inmagic Web Services Guide Inmagic Proprietary and Confidential Page 1 How to Create a SOAP Interface for a Textbase You can create a textbase specific WSDL file and accompanying transform and schema files using Inmagic net To created a SOAP interface for a textbase 1 2 3 Start DB TextWorks and open the textbase for which you want to create a SOAP interface Choose Inmagic net gt Configure Click the Create SOAP Interface button In the first box choose a field that uniquely identifies a record in a textbase The field must be term indexed present in every record and unique in every record An Automatic Number field would be ideal In the second box type the name of the server on which the SOAP interface will be installed Click the Create SOAP Interface button A message appears when the files have been created including the location and names of the files The location is wherever the textbase resides Close the software and copy these files to the SOAP subfolder of the WebPublisher PRO installation folder The following files are created your textbase name appears where lt textbase gt is shown for example cars wsdl textbase wsdl textbase input iwx lt textbase gt _output xsl textbase outputDS xsl textbase outputX xsl textbase recordset xsd textbase result xsd Inmagic Web Services Guide Inmagic P
7. ed e Ensure that your textbase does not contain multiple fields whose names would be equivalent when they are made SOAP compliant For example First Name and First Name both appear as First Name inthe SOAP interface See the DB TextWorks help file for information about SOAP compliant field names Note that the phrase SOAP compliant is a bit misleading SOAP itself has no problem with hyphens but Microsoft Visual Studio NET 2003 does not handle them well in variable names The SOAP interface automatically uses SOAPFormat 1 therefore there is no need to specify it separately in the DBTWPUB INI file Page 12 Inmagic Proprietary and Confidential The SOAP Interface Index A About DB TextWorks command v C customer support v D data models 3 Dataset model 3 6 DBTWPUB INI 12 delete 3 5 deleteDS 7 deleteX 9 E error handling 10 F file list 10 forums v functions 3 H hints for textbase design 12 Inmagic Inc v Inmagic net 2 insert 3 4 insertDS 6 insertX 8 M Microsoft Visual Studio NET 3 4 11 N namespace 11 O operations 4 P Product Support v Q qdelete 3 5 qdeleteDS 7 qdeleteX 9 query 3 4 query syntax error 10 queryDS 6 queryX 8 S serial number v SOAP fault 10 SOAP interface 3 SOAP compliant 12 Struct model 3 4 support v syntax error 10 T technical support v textbase design hints 12 troubleshooting 10 U
8. ifying the content Inmagic Web Services Guide Inmagic Proprietary and Confidential Page 3 Operations as seen in Visual Studio NET 2003 This section lists each operation as seen in Visual Studio NET 2003 and its parameters and returns In Visual Studio NET 2003 all parameters are required Therefore you must use an explicit null in place of any parameter that you do not want to use Struct model The Struct model has the following operations each with its own parameters and returns query Parameters string query string in command query format for example Find Author CT Smith string array containing names of fields to return If null all fields are returned string array containing names of fields to sort result on most significant first If a name is prefixed by minus sign or hyphen a descending sort is used If null the textbase default sort is used string password with which to open the textbase If null no password is passed in Returns lt textbase gt _recordsettypeRecord array of records retrieved where each record consists of a struct with a string member for each nonrepeating field and an array of strings member for each repeating field insert Parameters lt textbase gt _recordsettypeRecord array of new records to be inserted into the textbase string array containing the names of log fields to be returned in the confirmation response string
9. ing array containing the names of log fields to be returned in the confirmation response string password with which to open the textbase If null no password is passed in Returns textbase result dataset containing result of the operation Inmagic Web Services Guide Inmagic Proprietary and Confidential Page 7 XML model The XML model has the following operations each with its own parameters and returns queryX Parameters string query string in command query format for example Find Author CT Smith string array containing names of fields to return If null all fields are returned string array containing names of fields to sort result on most significant first If a name is prefixed by minus sign or hyphen a descending sort is used If null the textbase default sort is used string password with which to open the textbase If null no password is passed in Returns System Xml XmlElement XML structure conforming to the lt textbase gt _recordset schema insertX Parameters System Xml XmlINode XML structure conforming to a textbase record schema containing new records to be inserted into the textbase string array containing the names of log fields to be returned in the confirmation response string password with which to open the textbase If null no password is passed in Returns System Xml XmlINode XML structure conforming to the te
10. model lt textbase gt _resulttype struct containing result of an update insert or delete operation Struct model lt textbase gt _resulttypeRecord struct containing record information after an update insert or delete log fields status and error information lt textbase gt _resulttypeSummary struct containing summary information after an update insert or delete number of operations that succeeded failed and so forth lt textbase gt SOAP class containing the operations query queryDS and so forth as methods Tip If you decide to use the Dataset model recommended in Visual Studio NET 2003 after you add the Web reference add the dataset classes to your Web form You can then bind them to the control s of your choice for example a DataGrid Inmagic Web Services Guide Inmagic Proprietary and Confidential Page 11 Textbase Design Hints To maximize the ease of building your Web application using the SOAP interface review these recommendations e Make sure your textbase contains a field that is unique and required to serve as a record identifier e Consider applying single entry only validation to fields that you would never expect to repeat contain multiple entries In the Dataset model nonrepeating fields are returned in one table repeating fields each have a table of their own A field is assumed to be repeating unless it 1s an Automatic or Computed field or it has single entry only validation appli
11. nu click Forums Inmagic Web Services Guide Inmagic Proprietary and Confidential Page v Page vi Inmagic Proprietary and Confidential Inmagic Web Services Guide Web Services SOAP Interface This document describes the Web services SOAP interface available for use with the Inmagic DB Text product line Note that the Inmagic Web Services SOAP interface is suited for the Microsoft Visual Studio NET 2003 development environment in which it was tested It has not been validated in any other development environments Inmagic DB TextWorks is a content management system a type of database software that enables you to build networked and standalone textbases to manage text numbers dates and electronic images DB TextWorks combines traditional database power including the ability to manipulate data and perform arithmetic calculations with the ability to handle large amounts of text When you want to publish your textbase s over the Web you need to use DB Text WebPublisher PRO Inmagic DB Text WebPublisher PRO is a separate product that you purchase for use with DB TextWorks WebPublisher PRO enables you to publish textbases on an intranet or the Internet so Web users can search and modify them that is add modify and delete information from your desktop and or via a Web browser DB TextWorks is the buildware for creating searchable textbases WebPublisher PRO has its own user s manual but its online help is integr
12. prietary and Confidential Page 9 File List This section lists the files that comprise the SOAP interface for one textbase and describes their functions File Description lt textbase gt wsdl lt textbase gt _input iwx lt textbase gt _output xsl textbase outputDS xsl lt textbase gt _outputX xsl lt textbase gt _recordset xsd lt textbase gt _result xsd Error Handling Web Services Description Language file containing a textbase aware specification of the SOAP operations described in the previous section Input transform used to convert an incoming SOAP message to XML suitable for submission directly to WebPublisher PRO This file has an IWX extension because that extension has been mapped to WebPublisher PRO Output transform used to convert XML returned by WebPublisher PRO into a SOAP response using the Struct model Output transform used to convert XML returned by WebPublisher PRO ito a SOAP response using the Dataset model Output transform used to convert XML returned by WebPublisher PRO into a SOAP response using the XML model Schema describing the recordset returned after a query operation Schema describing the result logfields and status returned after an insert update or delete operation Also describes an error returned if applicable Errors may be returned as SOAP faults or as information contained in the response SOAP faults are generated when the software is unable to process
13. roprietary and Confidential Page 2 The SOAP Interface There are five 5 basic functions supported in the SOAP interface query with optional sorting insert update delete and qdelete There are three 3 data models available for each of these functions Struct Dataset and XML The operations that implement these functions are listed in the following table Struct Dataset XML query queryDS queryX insert insertDS insertX update updateDS updateX delete deleteDS deleteX qdelete qdeleteDS qdeleteX In the Struct model records are represented as nested arrays of strings A set of records is an array of records where a single record is a struct or class whose elements are field names A field is either a string in the case of a field that cannot repeat or an array of strings in the case of a field that can repeat A field is assumed to be repeating unless it is an Automatic or Computed field or it has single entry only validation applied In the Dataset model a set of records is represented in an ADO NET dataset A record table in the dataset contains columns for all of the nonrepeating fields Repeating fields each have a table of their own automatically related to the record table The Dataset model is especially suited to the Microsoft Visual Studio NET 2003 development environment In the XML model record sets records and fields are all XML elements nested as you would expect The field names serve as the XML tags ident
14. ssed in Returns lt textbase gt _result dataset containing result of the operation updateDS Parameters lt textbase gt _recordset dataset containing the records to be modified in the textbase If any records in the dataset have changes of type inserted or modified only those records are updated or added If no records have changes all are updated or added string array containing the names of log fields to be returned in the confirmation response string password with which to open the textbase If null no password is passed in Returns lt textbase gt _result dataset containing result of the operation Page 6 Inmagic Proprietary and Confidential The SOAP Interface deleteDS Parameters lt textbase gt _recordset dataset containing the records to be deleted from the textbase If the dataset contains deleted records only those records are deleted from the textbase If the dataset contains no deletions all of the records are deleted from the textbase string array containing the names of log fields to be returned in the confirmation response string password with which to open the textbase If null no password is passed in Returns textbase result dataset containing result of the operation qdeleteDS Parameters string query string in command query format for example Find Author CT Smith all records found by this query will be deleted str
15. t Inmagic Inc or your local Inmagic dealer If you have a Technical Support contract please have the contract number handy and try to be at your computer when you call If that is not possible note exactly what you were doing when you encountered the problem the exact text of any error messages you received and your software version and serial number choose Help gt About DB TextWorks to look it up If you do not have a Technical Support contract you can contact Inmagic Sales to purchase a support plan Inmagic Inc 200 Unicorn Park Drive Fourth Floor Woburn MA 01801 U S A Tel 781 938 4444 or 800 229 8398 Fax 781 938 4446 http www inmagic com support inmagic com technical support questions and feature requests CustomerSvc inmagic com general company product and services questions sales inmagic com sales product pricing and custom solution questions wishlist inmagic com feature requests If your message is intended for a particular person at Inmagic Inc for example a Technical Support representative who is expecting the message or files please include the name of that person in the subject and the message Communicating with Other Users You can participate in user to user discussions through an Inmagic forum on the Web Note that the forums are not an official customer support channel for Inmagic products To participate in a forum go to the Inmagic Web site http www inmagic com and from the Support me
16. update 3 5 updateDS 6 updateX 8 W Web forums v Web Services Description Language file 2 10 WSDL file 2 10 X XML model 3 8 Inmagic Web Services Guide Inmagic Proprietary and Confidential Page 13 Page 14 Inmagic Proprietary and Confidential Inmagic Web Services Guide
17. which to open the textbase If null no password is passed in Returns lt textbase gt _resulttype log fields and status succeeded failed for each record retrieved by the query also contains error information Inmagic Web Services Guide Inmagic Proprietary and Confidential Page 5 Dataset model The Dataset model has the following operations each with its own parameters and returns queryDS Parameters string query string in command query format for example Find Author CT Smith string array containing names of fields to return If null all fields are returned string array containing names of fields to sort result on most significant first If a name is prefixed by minus sign or hyphen a descending sort is used If null the textbase default sort is used string password with which to open the textbase If null no password is passed in Returns lt textbase gt _recordset dataset containing the records retrieved insertDS Parameters lt textbase gt _recordset dataset containing the new records to be inserted into the textbase If any records in the dataset have changes of type inserted only those records are added to the textbase If no records have changes all are added to the textbase string array containing the names of log fields to be returned in the confirmation response string password with which to open the textbase If null no password is pa
18. xtbase result schema updateX Parameters System Xml XmlINode XML structure conforming to a textbase record schema containing records to be updated in the textbase string array containing the names of log fields to be returned in the confirmation response string password with which to open the textbase If null no password is passed in Returns System Xml XmlINode XML structure conforming to the textbase result schema Page 8 Inmagic Proprietary and Confidential The SOAP Interface deleteX Parameters System Xml XmlINode XML structure conforming to a textbase record schema containing records to be deleted from the textbase string array containing the names of log fields to be returned in the confirmation response string password with which to open the textbase If null no password is passed in Returns System Xml XmlINode XML structure conforming to the textbase result schema qdeleteX Parameters string query string in command query format for example Find Author CT Smith all records found by this query will be deleted string array containing the names of log fields to be returned in the confirmation response string password with which to open the textbase If null no password is passed in Returns System Xml XmlINode XML structure conforming to the lt textbase gt _result schema Inmagic Web Services Guide Inmagic Pro
Download Pdf Manuals
Related Search