dSERVETM Business Basic File Services for the Rest of the World ©2003 by Allen Miglore. All rights reserved. Published under license by Synergetic Data Systems Inc. Version 2.0 dSERVE is a trademark of Synergetic Data Systems Inc. PRO/5, Visual PRO/5, and BBx are registered trademarks of BASIS International. ProvideX is a trademark of Sage Technologies Inc. Other product names used herein may be trademarks or registered trademarks of their respective owners. Table of Contents INTRODUCTION............................................................................................................................................................1 APPLICATION ARCHITECTURE ..............................................................................................................................2 BUSINESS BASIC FILE CONCEPTS ..........................................................................................................................3 SERVER INSTALLATION AND SETUP ....................................................................................................................4 ACTIVATION..................................................................................................................................................................6 BUNDLED INSTALLATIONS .............................................................................................................................................6 SERVER CONFIGURATION........................................................................................................................................7 STARTUP CONFIGURATION.............................................................................................................................................7 SERVER SECURITY .........................................................................................................................................................7 DATE CONFIGURATION ..................................................................................................................................................9 DATA DICTIONARIES AND DICTIONARY EXTENSIONS ................................................................................10 BASIS SQL ENGINE SUPPORT.................................................................................................................................12 WINDOWS CLIENT DLL INSTALLATION ............................................................................................................13 PERL AND PHP CLIENTS..........................................................................................................................................14 ERROR CODES ............................................................................................................................................................15 CLIENT FUNCTION DECLARATIONS AND USAGE...........................................................................................18 OPEN A CONNECTION...................................................................................................................................................18 CLOSE A CONNECTION .................................................................................................................................................19 OPEN A FILE.................................................................................................................................................................19 LIST DICTIONARY ........................................................................................................................................................20 OPEN A FILE VIA THE DATA DICTIONARY ....................................................................................................................20 LIST FILE FIELDS .........................................................................................................................................................21 LIST A FILE’S INDEXES.................................................................................................................................................22 CLOSE A FILE ...............................................................................................................................................................22 ASSOCIATE A STRING TEMPLATE WITH A FILE.............................................................................................................22 SET A TEMPLATE FIELD ATTRIBUTE ............................................................................................................................24 FILTER RECORDS FROM SEQUENTIAL READS ..............................................................................................................25 READ BINARY DATA....................................................................................................................................................26 READ A FULL RECORD BY KEY....................................................................................................................................26 EXTRACT A FULL RECORD BY KEY..............................................................................................................................27 READ NEXT FULL RECORD ..........................................................................................................................................27 READ PREVIOUS FULL RECORD ...................................................................................................................................28 READ RECORD FIELDS BY KEY ....................................................................................................................................28 EXTRACT RECORD FIELDS BY KEY ..............................................................................................................................30 READ NEXT RECORD FIELDS .......................................................................................................................................31 READ PREVIOUS RECORD FIELDS ................................................................................................................................31 GET FILE KEYS ............................................................................................................................................................32 FILE IDENTIFICATION ...................................................................................................................................................32 FILE INFORMATION ......................................................................................................................................................32 BASIC FILE STATISTICS................................................................................................................................................33 TEMPLATE FIELD ATTRIBUTES.....................................................................................................................................33 GET DATE MANAGEMENT INFORMATION ....................................................................................................................34 SET DATE MANAGEMENT INFORMATION .....................................................................................................................35 GLOBAL STRING SET (STBL OR GBL) ........................................................................................................................35 GLOBAL STRING GET (STBL OR GBL)........................................................................................................................35 WRITE RECORD............................................................................................................................................................36 WRITE RECORD FIELDS................................................................................................................................................36 REMOVE RECORD BY KEY ...........................................................................................................................................37 CREATE A KEYED FILE.................................................................................................................................................38 CREATE A TEXT FILE ...................................................................................................................................................38 ERASE A FILE ...............................................................................................................................................................38 DATA EXPORTING FUNCTIONS.............................................................................................................................40 EXECUTE AN EXPORT...................................................................................................................................................40 START AN EXPORT .......................................................................................................................................................41 CHECK EXPORT STATUS ..............................................................................................................................................41 GZIP A FILE ..................................................................................................................................................................42 SERVER INTERFACE SPECIFICATION ................................................................................................................43