Home

TFORMer SDK Developer Manual V7.0

1. TAB Tabulator character 0x09 Value Value Value Semicolon 0x3B Value Value Value Comma 0x2C Value Value Value Space Space character 0x20 Value Value Value Other Any other single character Value Value Value B 3 1 2 Valid Line Separators Char Description Example LF Line Feed 0x0A Text files created under UNIX or LINUX CRLF Carriage Return Line Feed 0x0D 0x0A Text files created under Windows or MS DOS B 3 1 3 Valid Text Qualifiers Char Description Example 5 Double quote character 0x22 Value Single quote character 0x27 Value Other Any other single character Value None Value All characters which are enclosed with a text qualifier are imported as one single value Thus you can use the column separator character in strings too WWW TEC IT COM Page 42 of 53 If you want to use a line break within a string please use the escape sequence n new line When importing the data the n will be replaced with a new line character B 4 Important Notes B 4 1 1 Empty or Missing Datafield Values TFORMer SDK uses the default value of a datafield if no value is defined in the datasource This behavior can be adjusted using with tfprint command line parameters see command line switch CL yes no B 4 1 2 Additional Datafields in an Import File TFORMer SDK ignores datafields which are not defined in the form des
2. and these subdirectories are holding the single form layouts Therefore moving or copying a repository must always include the subdirectories Using a repository simplifies maintenance of multiple form layouts which share the same datafields In addition a repository is a must with TFORMer Server When printing a repository based form the user must specify the name and path of the repository the project within the repository and the name of the form layout A 4 Project A repository is divided into so called projects Each project holds definitions for datasources datafields and one or more form layouts All form layouts using the same datafields and or datasources should be grouped in a project A 5 Datafield A form layout may use datafields as place holders for dynamic data The content of these placeholders is provided during runtime print time by external datasources or by the user At runtime each occurrence of a datafield is replaced with the current data Datafields may be used as part of expressions WWW TEC IT COM Page 37 of 53 In contrast to a stand alone form which stores all datafield definitions itself a repository based form may use datafields defined in the project where the document layout is located That means that all forms belonging to a project can use the same datafields In addition to such project specific datafields TFORMer supports global datafields These datafields are available for all document la
3. Adda NAME EORR OURB DATA TED Sawin e me thce vial Wem Om enenda aE ea jobdata Records Add record Zrmalilyapenimtsnste JODA PETNE End Sub 8 3 More Information For more information please check out the following documents and sample applications NET Programming Reference Start Menu All Programs TEC IT TFORMer 7 0 SDK API References gt NET Programming Reference Sample Code Start Menu All Programs TEC IT TFORMer 7 0 SDK gt Examples Programming WWW TEC IT COM Page 20 of 53 9 DLL Dynamic Link Library 9 1 Introduction Besides the COM and NET Interface the TFORMer SDK contains also a Microsoft Windows DLL 32 bit 64 bit A DLL is a library which offers its functionality via a documented interface DLLs can be used in Most programming languages and development environments e g Visual C C NET all versions of Visual Studio Visual Basic Borland C Builder Borland Delphi Web based scripting languages like PHP gt Please note The DLL is only available on Microsoft Windows If you need to use a DLL like interface on Linux UNIX please use the shared library see chapter 10 9 2 Compiling Your Applications The files TFormer70 lib library and TFormer7 h header file are required to compile and link your own applications with the TFORMer DLL These files are usually stored in one of the following folders C Program Files TEC IT TFORMer7 Bin
4. Examples Microsoft Office WWW TEC IT COM Page 31 of 53 14 TFORMer in Web Applications 14 1 TFORMer SDK with Web Applications on Windows 14 1 1 Client side use of TFORMer SDK When printing from within a web browser the user usually has to confirm the print job by selecting a target printer this is due to browser implementation details You can avoid this limitation by using the COM component of TFORMer SDK It enables your web based application to print to arbitrary printers without any user interaction These are the steps to use the COM based API of TFORMer SDK within web pages on client side 1 The TFORMer SDK COM component has to be installed on each client Take care that only Microsoft Internet Explorer is supported A CAB file for automatic installation is available from TEC IT 2 Use VBScript or JavaScript in a web page which instantiates a TFORMer class a sample using VBScript is installed by the setup Check out the following menu entry Start Menu All Programs TEC IT TFORMer 7 0 SDK Examples Programming 3 Provide the form layouts either locally on the client on a shared network folder as BASE64 strings embedded directly into tne HTML page or via http on an arbitrary server see 14 1 3 4 The web page provides data to the TFORMer SDK COM object programmatically 5 You web application prints to local printers without any extra user confirmation 14 1 2 TFORMer SDK on a Windows based Web
5. 2008 or higher Borland C Builder Borland Delphi Microsoft Office product suite in conjunction with Visual Basic for Applications VBA HTML pages on client or server side ASP ASP NET VBScript Internet Explorer Command line based scripting environments Visual Basic Scripting Host Please note COM technology is only available on Microsoft Windows 7 2 Outline gt gt gt The name of the type library is TFORMer 7 0 SDK Type Library The GUID is 03234571 9079 45aa 921B 51BAEC081851 The Class ID of the COM Control is 68442B0A 0C5A 4569 AED5 6026B95A602B The general steps for using the COM API of TFORMer SDK are als Ore Gee Embed the TFORMer COM component into your application or document Usually this is done by establishing a reference to the TFORMer 7 0 SDK Type Library Create an instance of the TFORMer70Lib TFORMer COM class Create a job instance Create a datasource instance and connect the job with the datasource Set the properties of the job object e g name of the form layout output type and printer name Provide or import the values for data fields via the datasource object Finally call the Print method The general VBA code for using TFORMer SDK looks as follows This code snippet demonstrates the basic steps for using the TFORMer SDK COM component from within VBA Take care to establish a reference to TFORMer 7 0 SDK Type Library
6. Linux machines quite good depends on X settings gt lt 72dpi might be a good choice if your target audience is on MAC OS ailen gt lt l barcode opt esolution print barcodes in optimal resolution gt SuSE This will create readable barcodes which gt lt might look different as in design mode gt lt always print barcodes will print barcodes even if they will be gt QIES not readable This is ONLY useful for gt Glee preview purposes lt HTML media A4 orientation portrait resolution 96 barcode opt resolution 0 always print barcodes 1 gt lt IMAGE OPTIONS Configure settings for image output gt lt media Default media size must be listed in lt DefinedMedia gt gt lt orientation Default orientation landscape portrait SIT Zresolute on The output resolution in dpi Sales ai iesin 1 enabled SS lt i 0 disabled eas Anti aliasing improves the quality of the output gt al in lower resolutions or for on screen display gt Si jpeq qualiaty jpeg quality setting for jpeg compression 0 100 gt lt tiff compression Compression of generated tiff images gt WWW TEC IT COM Page 46 of 53 Sc A few compression schemes are only allowed for b amp w CES a or color output Suggested values that should always gt lt work are nocomp lzw or jpeg gt SSS Valid values gt giles noconpy zw packets eert Scilly Ccittiox j
7. Server TFORMer SDK at server side can be used as part of web applications or web services Server side use does not bind your clients to specific browsers or operating systems Some NET based sample applications demonstrate the use of TFORMer SDK with server based web applications Check out the following menu entry Start Menu All Programs TEC IT TFORMer 7 0 SDK Examples Programming 14 1 3 Web Based Form Layouts TFORMer SDK is able to access form layouts repositories or data files via http When using ffprint this looks like tfprint F http something com OnlineReport_1 tff 14 2 TFORMer SDK on Linux or UNIX Servers The TFORMer SDK can be incorporated easily into server based applications Your server based application e g written in PHP CGl Perl Java C C invokes ffprint as external process to generate the output data e g a PDF file The TFORMer SDK for Linux UNIX includes a ready to use example showing how fforint can be integrated in a web application The sample application is written in PHP and is installed in usr local share TFORMer SampleCodeCGI This sample requires a configured apache web server which supports PHP5 To deploy the applica tion all files in the application directory have to be copied into the root directory of the web server WWW TEC IT COM Page 32 of 53 The file feedback php contains the application logic to supply user data using XML to ffprint and to create a PD
8. UNIX 12 2 Outline The general steps for using ffprint are 1 Create the required form layouts using TFORMer Designer 2 Provide data for the form layouts via XML CSV TXT or ODBC datasources 3 Embed tfprint into your batch job shell script or applications gt On Microsoft Windows the files for the form layouts or file based datasources XML CSV or TXT may be provided as a filename as file stored in the file system or as http based URL fa amp Kommandozeilendruck TFPrint TFPrint V 6 1 16534 SDK Command Line TFORMer Reporting Engine lt c 2662 2612 TEC IT Datenverarbeitung GmbH http uwu tec it com F Repository Project Form FormFile D DataFile or DataSourceName DT lt XMLiTEXT iTFORMER TFS t ODBC DATASOURCE 1 DO CL yes inol l ESCI Iyes inol l SCc QCc RCFnanme RCAnane DSN name CUSER user PWD password SQL statement XSLT file ParamName value O DevOrFile OT lt WIN32 REPO PS PSPRINTER PDF HTML TAT TATPRINTER i IMGBMP i IMGGIF i IMGJPG i IMGPCK i IMGPNG i IMGTGA i IMGTIF IMGMULTITIF ZPLi ZPLPRINTER gt 00 CPn TCname SRn SCn DXN CDRH DXU CJTtitle L LicenseeName LicenseKey NumberOfLicenses LicenseKind E C CommandFileASCII J LCUPS SYSTEMID CONFIG File SDK Options H i Show detailed help C Windows s ystem32 gt _ Figure 1 tfprint command line parameters When using tfprintt
9. compression method nocomp jpeg flate rle auto gt ee nocomp no compression Sl jpeg non monochrome images will be jpeg compressed gt monochrome images will use flate or rle gt a compression gt Zi flate all images will be flate compressed gt Sn areles all images will be run length encoded gt Sl auto depends on jpeg enabled and flate enabled gt SiS uses jpeg compression for jpeg files gt Oz flate or rle for others gt Si jpeq qualaty jpeg quality setting for jpeg compression 0 100 gt lt jpeg enabled enables jpeg compression for auto compression mode lt Elatezenabled enables flate compression for auto compression mode Sam requires Postscript Language Level 3 support gt lt Images compression method auto jpeg quality 75 jpeg enabled 1 flate enabled 0 lt Images can be downsampled if they are higher than the specified resolution gt lt enabled 0 1 enable disable downsampling of images So Gja all images are downsampled to this resolution lt Downsample enabled 1 dpi 300 gt lt Images gt lt POSTSCRIPT gt Sl ZEIT MESOPTTONS Configure settings for HTML output gt lt media Default media size must be listed in lt DefinedMedia gt gt SI Orientacion Default orientation landscape portrait gt lt 96dpi this should be used as default resolution for Microsoft Windows gt lt I 108dpi seems to work on
10. for jpegs else zip gt lt jpeg quality jpeg quality setting for jpeg compression 0 100 lt Images compression method auto jpeg quality 80 gt WWW TEC IT COM Page 45 of 53 lt Images can be downsampled if they are higher than the specified resolution gt lt enabled 0 1 enable disable downsampling of images gt tea all images are downsampled to this resolution gt lt Downsample enabled 1 dpi 300 gt lt Images gt lt PDF gt lt POSTSCRIPT OPTIONS Configure settings for PostScript output lt media Default media size must be listed in lt DefinedMedia gt gt SZ Zorientace on Default orientation landscape portrait A colormmnode color grayscale blackwhite gt SZ uplek Seleets duplex or double sided printing for printers SE capable of duplex printing gt ea default simplex vertical horizontal gt qle deratiiey use printer settings gt Wes simplex normal nonduplex printing gt Sle UN Sheleaber yh double sided printing using a gt ellos vertical page turn gt Stas horizontal double sided printing using a ie horizontal page turn gt lt Header Path to the PostScript header file gt lt I Footer Path to the PostScript footer file gt lt POSTSCRIPT media A4 orientation portrait colormode color duplex default gt lt Header filename header ps gt lt Footer filename footer ps gt lt
11. from an URL for printing PDF output options page setup size orientation compression margins embedding of fonts image compression method and jpeg quality maximum resolution for images down sampling PostScript output options page setup size orientation color mode external header footer file character encoding HTML output options page setup size resolution barcode output options optimize for readability print unreadable barcodes ZPL II ZEBRA printers output options Barcode generator options drawing method for windows printers Paper format names for trays File dump of the default TFORMer xmi configuration file WWW TEC IT COM Page 44 of 53 lt xml version 1 0 encoding UTF 8 gt lt TFORMer major 1 minor 0 gt lt c 1998 2012 TEC 1T Datenverarbeli tung GmbH lt htpp www tec it com gt Sl eupporteree ir com lt This TFORMer configuration file contains standard settings for the gt lt i output methods Edit this fille 12f you want to change specific output lt options or if you need to add custom media sizes gt lt Note In previous versions the term lt Form gt was used instead of lt Media gt SIZ ZEOMMON Options Configure settings that apply ito alll printers gt lt COMMON gt lt li rorHend lang gt lt l Decides what TEORMer does if a barcode image or expression error occurs o lt i during printing A
12. height 594000 gt lt Media name A3 width 297000 height 420000 gt lt Media name A4 width 210000 height 297000 gt lt Media name A5 width 148000 height 210000 gt lt Media name A6 width 105000 height 148000 gt lt Media name A7 width 74000 height 105000 gt lt Media name A8 width 52000 height 74000 gt lt Media name A9 width 37000 height 52000 gt lt Media name A10 width 26000 height 37000 gt lt Media name BO width 1000000 height 1414000 gt lt Media name B1 width 707000 height 1000000 gt lt Media name B2 width 500000 height 707000 gt lt Media name B3 width 353000 height 500000 gt lt Media name B4 width 250000 height 353000 gt lt Media name B5 width 176000 height 250000 gt WWW TEC IT COM Page 47 of 53 lt Media name B6 width 125000 lt Media name B7 width 88000 lt Media name B8 width 62000 lt Media name B9 width 44000 lt Media name B10 width 31000 lt Media name C0O width 917000 lt Media name C1 width 648000 lt Media name C2 width 458000 lt Media name C3 width 324000 lt Media name C4 width 229000 lt Media name C5 width 162000 lt Media name C6 width 114000 lt Media name C7 width 81000 lt Media name C8 width 57000 lt Media name C9 width 40000 lt Media name C10 width 28000 lt Media name D0 width 771000 lt Media n
13. the basic steps for using the DLL interface 7 define TECIT DLLIMPORT before including TFormer 7 h define TECIT_DLLIMPORT enable a TFORMer Unix build using the two defines below define TEC_UNIX define TEC_UNIX BUILD Set the define for the concrete OS you are using define TEC_LINUX define TEC FREEBSD define TEC AIX define TEC HPUX define TEC SOLARIS define TEC _0S400 define TEC SCO include the TECITStd header for required defines include lt STEETTSEI TECTTSEdr gt include TFORMer7 h include lt TFormer7 h gt undefine as they are only required for TFORMer Header files undef TECIT DLLIMPORT undef _TEC_UNIX undef TEC_UNIX BUILD Handle for TFORMer SDK HTFORM hTForm NULL initialize TFORMer SDK hTForm TFormer Init NULL Select the form to be printed a 3 Former SetRepositoryName hTForm FILENAME OF_YOUR_FORMLAYOUT tff use the CUPS default printer of the system a 2 Former SetPrinterName hTForm NULL NULL Add a Data record 5 J Former NewRecord hTForm Set a Datafield value 3 Former SetVarValue hTForm NAME OF YOUR_DATAFIELD Value of the datafield MESCE PEINER E a J Former Print hTForm Exit TFORMer Former Exit hTForm WWW TEC IT COM Page 24 of 53 10 4 Sample Application A sample a
14. the programming language include the TECIT TFORMer namespace Create a job instance TECIT TFORMer Job Create a jobdata instance TECIT TFORMer JobData or derived classes Connect the job with the jobdata Set the properties of the job to the required values e g name of the form layout output type and printer name 7 Provide or import the values for data fields via the jobdata 8 Finally generate the required output with the Print method BO eS The general code for using TFORMer SDK in Visual Basic NET looks as follows This code snippet demonstrates the basic steps for using the TFORMer SDK from within VB NET Take care to establish a reference to TFORMer 7 0 SDK from within your project Private Sub TFORMer Output Declare the variables Dim job As TECIT TFORMer Job Dim jobdata As TECIT TFORMer JobDataRecordSet create objects for a job and a jobdata job New TECIT TFORMer Job jobdata New TECIT TFORMer JobDataRecordSet connect the jobdata with the job job JobData jobdata WWW TEC IT COM Page 19 of 53 select the form layout to be printed generated adjust the type and name of the output job RepositoryName FILENAME OF YOUR_FORMLAYOUT tff job OutputName C temp output pdf job PrinterType TECIT TFORMer PrinterType PdfFile provide data for the datafields used in the form layout Dim record As TECIT TFORMer Record record New TECIT TFORMer Record Recordr Vata
15. the value of the datafield datasource add record il eame orale ale JOOP PEINE catch TFormerException ex throw ex Finally dispose ALWAYS the resources in order to free the TFORMer SDK resources job dispose job null Please note In order to free the resources allocated by TFORMer SDK it s important to call the method dispose of the JTFormer classes A use of the TFORMer Java classes without the invocation of the method dispose can cause memory allocation problems and leaks 11 3 More Information For more information please check out the following documents and sample applications Java Programming Reference Start Menu All Programs TEC IT TFORMer 7 0 SDK API References Java Programming Reference Sample Code Start Menu All Programs TEC IT TFORMer 7 0 SDK Examples Programming WWW TEC IT COM Page 27 of 53 WWW TEC IT COM 12 Command Line Application 12 1 Introduction The TFORMer SDK command line application is available for Microsoft Windows Linux and UNIX It generates output based on arbitrary form layouts created with TFORMer Designer The executable is named tfprint or tfprint exe on Microsoft Windows and can be used on its own executed manually as part of batch jobs or shell scripts via shell execute as out of process reporting engine as extension for printer filter applications on Linux
16. to third parties without express authority is strictly forbidden Fur dieses Dokument und den darin dargestellten Gegenstand behalten wir uns alle Rechte vor Vervielf ltigung Bekanntgabe an Dritte oder Verwendung au erhalb des vereinbarten Zweckes sind nicht gestattet 1998 2012 TEC IT Datenverarbeitung GmbH Hans Wagner Str 6 A 4400 Austria t 43 0 7252 72720 f 43 0 7252 72720 77 http www tec it com WWW TEC IT COM Page 5 of 53 3 3 1 Introduction TFORMer The TFORMer product family represents a complete lean and powerful solution for generating arbitrary documents It combines the features of barcode labeling tools with the characteristics of report generators into a unified printing solution It provides professional layout and output capa bilities an integrated barcode generator full featured UNICODE support output streaming and direct PDF generation 3 2 Areas of Application for TFORMer SDK TFORMer SDK provides the core output functionality of the TFORMer product family It can be used on client and on server side and it is available for all major operating systems It can be embedded in your own applications easily Due to the support of multiple output formats TFORMer SDK has a wide field of applications gt Reporting Engine For software developers the combination of TFORMer SDK and TFORMer Designer provides a generic reporting solution which enables end customers to create ed
17. trademark or registered trademark we ask you to send us a short message mailto office tec it com WWW TEC IT COM Page 36 of 53 Appendix A Terms and Definitions A 1 Form Layout A form layout is a document created with TFORMer Designer It is basically an XML file which stores all layout information with the corresponding parameters like position font size color A form layout usually contains static and dynamic data Dynamic data is provided by a datasource and used via datafields in the form layout A form layout is either stored in a repository tfr or stored as a stand alone form layout tff A 2 Stand Alone Form A stand alone form is a document which is stored as single file and which is not contained in a repository TFORMer Designer normally creates stand alone forms but it can be instructed to add forms to a repository Stand alone forms are using the file extension tff All required information of a stand alone form is contained in the layout therefore it can be printed by its own Stand alone form layouts are the most basic type of layout definitions and are very easy to use A 3 Repository A repository is a central location in the file system for storing form layouts Furthermore the repository contains datasources and datafields which may be defined once for multiple layouts The main file of a repository is using the file extension tfr The subdirectories are named like the projects
18. width 560000 lt Media name P2 width 430000 lt Media name P3 width 280000 lt Media name P4 width 215000 lt Media name P5 width 140000 lt Media name P6 width 107000 lt i add custom Lorms bellow this peime gt lt DefinedMedia gt lt TFORMer gt WWW TEC IT COM heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig heig ht 176000 ht 125000 ht 88000 ht 62000 ht 44000 ht 1297000 ht 917000 ht 648000 ht 458000 ht 324000 ht 229000 ht 162000 ht 114000 ht 81000 ht 57000 ht 40000 ht 1091000 ht 771000 ht 545000 ht 385000 ht 272000 ht 192000 MEM Il SOOO MES UNEO OO ht 1120000 ht 800000 ht 560000 ht 400000 ht 280000 ht 200000 ht 140000 ht 100000 ht 1456000 e TO 300907 ht 728000 nie 15150 0027 ht 364000 ht 257000 ht 182000 ht 128000 ht 91000 ht 64000 ht 45000 ht 216000 ht 254000 RESUS DOO ht 127000 ht 279400 ht 279400 ht 431800 Die VS SOOO ht 210000 ht 297000 ht 241000 ht 220000 De SSO ZO ht 860000 ht 560000 ht 430000 hi
19. C Program Files x86 TEC IT TFORMer7 Bin Make sure the compiler and the linker are able to locate these files 9 3 Outline The general steps for using the TFORMer DLL are 1 Include TFormer7 h Make sure to define TECIT_DLLIMPORT before including the header file Initialize the TFORMer DLL and save the handle TFormer_Init Select the form layout to be printed TFormer_SetRepositoryName Select the type of the output and the target file or device TFormer_SetPrinterName Provide values for datafields if any in the form layout Generate or print the output TFormer_Print De initialize TFORMer SDK TFormer_Exit N OF AK amp The general C code for using TFORMer DLL looks as follows This is not a complete application It is just a sample without any error handling to demonstrate the basic steps for using the DLL interface Ki define TECIT DLLIMPORT before including TFormer7 h define TECIT DLLIMPORT include PATH TO TFORMER TFormer7 h undef TECIT DLLIMPORT Handle for TFORMer SDK HTFORM hTForm NULL initialize TFORMer SDK WWW TEC IT COM Page 21 of 53 hTForm TFormer Init NULL Select the form to be printed TFormer SetRepositoryName hTForm FILENAME OF YOUR_FORMLAYOUT tf use the default printer of the system TFormer SetPrinterName hTForm NULL NULL Add a Data record TFormer NewRecord hTForm Set a Datafield value TFo
20. F file from the user data and a form layout file 14 3 TFORMer SDK on Java Web Applications Through the Java component of TFORMer SDK it s possible to build J2EE printing applications and deploy them into the J2EE Application Server i e Tomcat and JBoss This solution permits to print files on server side based on certain user configurations or data It s important to remember that the Application Server must read the TFORMer DLLs or shared libraries in order to access to the TFORMer SDK For details see chapter 11 Java Component Check out the following menu entry to find simple examples of JSP Servlet using the Java component of TFORMer SDK Start Menu gt All Programs TEC IT TFORMer 7 0 SDK Examples Programming WWW TEC IT COM Page 33 of 53 15 FAQ 15 1 Linux UNIX 15 1 1 TFORMer does not work If there are any problems with the installation of TFORMer SDK we recommend executing the following script usr local share TFORMer support sh This script is installed by the setup application and lists all relevant information like installed operating system library versions and the TFORMer SDK version Contact the support of TEC IT support tec it com with the output of this script along with a de tailed error description 15 1 2 TFORMer SDK does not print texts 32 bit TFORMer on 64 bit systems The output generated by the TFORMer SDK only contains images lines rectangles or similar ele ments Te
21. FieldNamel gt lt DataFieldName2 gt Value lt DataFieldName2 gt lt DataFieldName3 gt Value lt DataFieldName3 gt lt tblTableName gt lt tblTableName gt lt DataFieldNamel gt Value lt DataFieldNamel gt lt DataFieldName2 gt Value lt DataFieldName2 gt lt DataFieldName3 gt Value lt DataFieldName3 gt lt tblTableName gt Further Data Records lt dataroot gt WWW TEC IT COM Page 41 of 53 B 3 Text Files TFORMer can import text files in the CSV format Comma Separated Values or modifications of this format When importing text files you can specify the separator semicolon comma tab space and the text qualifier the symbol which encloses the actual values like text strings B 3 1 File Format Text files must be structured as follows The first line in the text file lists all column names names of the datafields The following lines contain the datafield values one record per line DataFieldNamel DataFieldName2 DataFieldNameN Value Value Value Value Value Value Further Data Records Example ArticleName ArticleNo ArticlePrice Cisuliee SHIIGS 2 LILO Desk 778920 150 Monitor ill 2 Si Panel 544593 40 Coffee Machine 549896 30 Printer 458862 100 Fax 445866 115 Phone 458932 50 You have the possibility to use different column separators line separators and text qualifiers B 3 1 1 Valid Column Separators Char Description Example
22. WWW TEC IT COM TFORMer SDK Reporting and Labeling SDK Version 7 0 Developer Manual 7 March 2012 TEC IT Datenverarbeitung GmbH Hans Wagner Strasse 6 A 4400 Steyr Austria t 43 0 7252 72720 f 43 0 7252 72720 77 office tec it com www tec it com 1 Content 1 Content 2 1 1 Table of Figures 4 2 Disclaimer 5 Introduction 6 3 1 TFORMer 6 3 2 Areas of Application for TFORMer SDK 6 3 3 This Document 6 4 Highlights of TFORMer SDK 7 4 1 Unified Output Solution 7 4 2 UNICODE Support 7 4 3 Barcode Support 7 4 4 Streaming 7 4 5 Reusable Smart Form Layouts 7 4 6 Cross Platform 7 4 7 Small Footprint High Performance 8 5 Installation on Microsoft Windows 9 5 1 Introduction 9 5 2 General 9 5 3 Sample Applications 9 5 4 Supported APIs 9 6 Installation on Linux or UNIX 11 6 1 Introduction 11 6 2 General 11 6 3 Sample Applications 12 6 4 Supported APIs 12 6 5 Platform Specific Installation Hints 12 6 5 1 Linux deb or rpm based 12 6 5 1 1 Dependencies 12 6 5 1 2 Rpm Installation 13 1 1 1 1 Rpm De Installation 13 6 5 1 3 Deb Debian Installation 13 1 1 1 2 Deb Debian De Installation 13 6 5 2 HP UX tarball 13 6 5 2 1 Dependencies 13 6 5 2 2 Installation 13 6 5 3 AIX tarball 14 6 5 3 1 Dependencies 14 6 5 3 2 Installation 14 6 5 4 Solaris tarball 14 6 5 4 1 Dependencies 14 6 5 4 2 Installation 15 7 COM Component 16 7 1 Introduction 16 7 2 Outline 16 7 3 Using the COM Objec
23. Windows Please make sure that you install the 64 bit version if you are using a 64 bit Windows operating system The 64 bit version includes all 32 bit components in addition e g 32 bit TFORMer COM API 5 2 General The installation of TFORMer SDK is straight forward the MSI setup application will install the TFORMer SDK components sample applications and documentation The default installation path is C Program Files TEC IT TFORMer7 SDK Please note that even the 64 bit DLLs will be installed into the x86 folder on 64 bit Microsoft Windows platforms which is usually C Program Files x86 5 3 Sample Applications Depending on your Windows version the sample applications and layout templates are installed in one of the following directories please note that Windows Explorer does not display the folder ProgramData by default you need to enable Show hidden files and folders in the Folder and Search options C ProgramData TEC IT TFORMer 7 0 or C Documents and Settings All Users Application Data TEC IT TFORMer 7 0 5 4 Supported APIs After installation the functionality of TFORMer SDK is available via the following APIs gt COM Component This API is available via the file TFORMerCOM70 dll The COM component is registered automatically by the setup application gt NET Component The file TECIT TFORMer dll provides the NET functionality NET 2 0 or higher is required The NET assembly is
24. alues for the datafields used in a form layout For this purpose three general methods are supported Imported data file Pass data to TFORMer SDK via a flat text file e g CSV or via XML files Take care to create the files with current data before printing the required form layouts User defined datasource The creator of a form layout can also specify a datasource XML file TXT CSV file ODBC queries in the document layout itself A unique name is assigned to each data source When printing a form layout just specify the name of the datasource and TFORmer DSK queries the data for printing automatically ODBC Pass data to TFORMer SDK via an ODBC database DSN user password and the suitable SQL select statement can be specie as required API Application Programming Interface Pass data to TFORMer SDK via method or function calls This method is not available for the command line interface tfprint B 2 XML Files Three different XML formats can be imported The internal XML format A generic XML format The XML format used in current versions of Microsoft Access B 2 1 Internal TFORMer XML Format The XML format used internally by TFORMer must be available exactly as specified below lt PSData gt lt Form gt lt Records gt lt Record Copies 1 gt lt V Name DataFieldNamel gt Value lt V gt lt V Name DataFieldName2 gt Value lt V gt lt V Name DataFieldName3 gt Value lt V gt lt Reco
25. ame D1 width 545000 lt Media name D2 width 385000 lt Media name D3 width 272000 lt Media name D4 width 192000 lt Media name D5 width 136000 lt Media name D6 width 96000 lt Media name D7 width 68000 lt Media name E0 width 800000 lt Media name E1 width 560000 lt Media name E2 width 400000 lt Media name E3 width 280000 lt Media name E4 width 200000 lt Media name E5 width 140000 lt Media name E6 width 100000 lt Media name E7 width 70000 lt Media name BOJIS width 1030000 lt Media name B1JIS width 728000 lt Media name B2JIS width 515000 lt Media name B3JIS width 364000 lt Media name BAJIS width 257000 lt Media name B5JIS width 128000 lt Media name B6JIS width 128000 lt Media name B7JIS width 91000 lt Media name B8JIS width 64000 lt Media name B9JIS width 45000 lt Media name B10JIS width 32000 lt Media name Invoice width 140000 lt Media name Executive width 191000 lt Media name Legal width 215900 lt Media name JuniorLegal width 203200 lt Media name Letter width 215900 lt Media name Ledger width 431800 lt Media name Tabloid width 279400 lt Media name Broadsheet width 432000 lt Media name Screen width 297000 lt Media name Custom width 210000 lt Media name Comm10 width 105000 lt Media name DL width 110000 lt Media name Folio width 210000 lt Media name P1
26. automatically installed in the GAC as well as in the Bin directory WWW TEC IT COM Page 9 of 53 gt DLL TFormer70 dll is a 32 bit Windows DLL TFormer70x64 dll is the 64 bit variant of it this naming scheme applies to all DLLs as well The corresponding library and include files are named TFormer70 lib and TFormer7 h For Linux and UNIX please refer to chapter 6 gt Command Line Application The command line based executable is named ffprint exe The command line application is also available for Linux and UNIX For details please refer to chapter 6 gt JAVA The JAVA API can be integrated in J2EE architectures web applications or web services and GUI applications e g Swing AWT JAVA version 1 5 or higher is required WWW TEC IT COM Page 10 of 53 6 Installation on Linux or UNIX 6 1 Introduction This chapter describes the installation of TFORMer SDK on Linux and UNIX based operating systems Depending on the operating system TFORMer SDK is available as rpm or tarball For details please refer to section 6 5 For a list of Linux or UNIX distributions which are supported with ready to run binaries please check out http www tec it com If you need binaries for your specific platform please let us know Whenever possible we provide them on request In some cases we perform remote builds after signing a NDA gt Please note that the report and label designer TFORMer Designer is only a
27. beforehand Private Sub TFORMer Output Declare the variables Dim TFormer Dim PrintJob Dim DataSource As TFORMer70Lib IDataSourceRecordSet create a TFORMer SDK instance Set TFormer CreateObject TFORMer70Lib TFormer create a job object with TFORMer Set PrintJob TFormer CreateJob create and connect a data source for providing datafields values WWW TEC IT COM Page 16 of 53 Set DataSource printjob NewDataSourceRecordSet select the form layout to be printed generated select type and name of the output PrintJob RepositoryName FILENAME OF YOUR_FORMLAYOUT tff PrintJob OutputName C temp output pdf PrintJob Printerlype TECIT TEORMer PrinterType PdfFile provide data for the datafields used in the form layout DataSource AddNewRecord DataSource SetDataField NAME OF YOUR_DATAFIELD This is the value of the datafield Finally print the form layout printjob PrintForm End Sub 7 3 Using the COM Object in Development Environments 7 3 1 ie 2 3 4 7 3 2 1 ee n Microsoft Visual Basic 6 Open or create your Visual Basic Project Choose Project gt References from the menu Choose TFORMer 7 0 SDK Type Library from the list select the entry and click OK Now you can use the COM based API of TFORMer SDK in your program Microsoft Visual C C 6 Open and create your MFC application e g by using the MFC App Wizard Make sure that Enable Automation is adjusted in y
28. bfreetype so 6 Iibfrreetype so extract shared library and create a link arn cx Maloy Iksjonl 252 lin e7 Iwoeuce lejal 2 90 2 liseo lejl 2 80 Good places for downloading precompiled packages are http www 03 ibm com servers aix products aixos linux download htm ftp ftp software ibm com aix freeSoftware aixtoolbox RPMS ppc 6 5 3 2 Installation The installation is identical to HP UX see section 6 5 2 2 6 5 4 Solaris tarball 6 5 4 1 Dependencies Before installing TFORMer SDK make sure to check if the following packages are available freetype 2 3 1 30110 x36 1oceal gz fontconfig 242 SOO s lt 36 lNocalung7 WWW TEC IT COM Page 14 of 53 6 5 4 2 Installation To install TFORMer SDK for Solaris 10 perform the following steps gunzipr IEORMer_7 020Zsolar s10rx86r targa cp TFORMer 7 0 0 solaris10 x86 tar cd tar xvf TFORMer 7 0 0 solaris10 x86 tar TFORMer is now installed in usr local bin The configuration file and documentation can be found in usr local share TFORMer You should now be able to print a demo PDF by executing usr local share TFORMer Demos DemoBarcodeLabels sh WWW TEC IT COM Page 15 0f 53 7 COM Component 7 1 Introduction COM components Component Object Model are software components which can be integrated seamlessly into other software products or used with development environments like Visual Basic Visual C Visual Studio NET Visual Studio
29. cord gt lt Record gt lt Record gt lt Record gt lt Records gt Further Data Records lt V Name DataFieldNamel gt Value lt V gt lt V Name DataFieldName2 gt Value lt V gt lt V Name DataFieldName3 gt Value lt V gt lt V Name DataFieldNamel gt Value lt V gt lt V Name DataFieldName2 gt Value lt V gt lt V Name DataFieldName3 gt Value lt V gt lt Root gt Description Name Description Root This is the root element It encloses all data within the xml file The element must not necessarily be named Root You can choose a name freely Records This element encloses all data records The element must not necessarily be named Records You can choose a name free ly Record This element describes one data record Within a record one value can be specified for each datafield The element must not necessarily be named Record You can choose a name freely V Data Element This element consists of the datafield name attribute Name and the actual datafield value DataFieldName Name of the datafield must be unique within a record Value The actual value of the datafield gt The nodes must not necessarily be named Root Records and Record The names can be chosen arbitrarily Only the order of the nodes is decisive TFORMer interprets the lowest level of the XML format as variable definitions and or datafields The superordina
30. create your document Activate the Visual Basic Editor This can be done by pressing the keyboard shortcut Alt F17 or by enabling the Visual Basic toolbar and clicking onto the Visual Basic Editor button In the Visual Basic editor click Tools References and check TFORMer 7 0 SDK Type Library to insert a reference to TFORMer SDK Click OK TFORMer SDK may now be used with VBA 13 2 4 Microsoft Access 2003 D Fa 8 Open or create your database Create a form or report by selecting Insert gt Form Report in the menu An empty form or report is opened Make sure the Design view is activated This can be done by selecting View Design in the menu Open the Visual Basic Editor by selecting View Code in the menu or by clicking the View Code symbol in the Form Design toolbar In the Visual Basic editor click Tools References and check TFORMer 7 0 SDK Type Library to insert a reference to TFORMer SDK Click OK TFORMer SDK may now be used with VBA 13 2 5 Other Microsoft Office versions The required steps are similar to the steps outlined for Microsoft Office 2003 13 3 More Information For more information please check out the following documents and sample applications COM Programming Reference Start Menu All Programs TEC IT TFORMer 7 0 SDK API References gt COM Programming Reference Sample Microsoft Excel Spreadsheet using TFORMer SDK Start Menu All Programs TEC IT TFORMer 7 0 SDK
31. depth documentation of the graphical layout editor WWW TEC IT COM Page 6 of 53 4 Highlights of TFORMer SDK 4 1 Unified Output Solution TFORMer SDK unifies output tasks A specific form layout produces identical output across printer models operating systems and output formats Supported output formats are Direct Printing Print layouts directly on all printers supported by Microsoft Windows PDF PDF export with full featured barcode support Unicode and font embedding PostScript Used for printing under Linux UNIX and for pre press applications HTML The built in HTML output is ideal for previewing and for web based applications Image Formats The built in image output supports BMP GIF JPG PCX TGA PNG and TIF formats including multipage TIF ZEBRA Print to ZEBRA printers without any additional driver ZPL II output is generated directly ASCII Pure ASCII output without any graphics for special purpose requirements 4 2 UNICODE Support The integrated UNICODE support allows you to use TFORMer SDK with almost any established language 4 3 Barcode Support TFORMer SDK offers integrated support for all linear 2D and composite barcodes in common use 4 4 Streaming Most of the supported output formats can be created as pure in memory stream without temporary files on the file system 4 5 Reusable Smart Form Layouts TFORMer SDK separates form layouts from the data It does not bind form layo
32. e 177310 0 0047 ht 215000 ht 140000 T gt gt ce fe Je fe gt fe ce aS gt aS gt f gt gt gt gt ae gt gt gt fe fe l gt gt ae CS a T fe ee ue gt aS Ve KS gt i gt gt gt gt ue gt gt fe We fe f gt ue gt ae Ce fe iS fe cS ue CS Page 48 of 53 Appendix D Distribution and Deployment Microsoft Windows D 1 Core Requirements If you want to use the TFORMer SDK within your own application or on the command line you have to distribute the files listed below These files must be shipped in order to enable basic TFORMer features and to offer complete printing support on Microsoft Windows based printers You need to deploy the x64 versions only if required if you are using the 64 bit SDK TFormer70 dll the main DLL for TFORMer SDK required in each case TFormerRep70 dll TECBaseU dil TFTBarCode10 dll TFPrint exe required for command line printing only freetype238MT dll freetype LICENSE iconv dll iconv LICENSE ibxmi2 dil libart_lgpl LICENSE libxml2 LICENSE Jibxsit dll zlib1 dll zlib README TFORMer xml contains system wide output options like page size PDF compression mode and more see Appendix C Additionally the Microsoft VC90 Common Runtime DLLs Visual C 2008 SP1 runtime compo nents are required on the target system There are two options
33. e files mentioned above TFORMer SDK is able to handle zip files directly When using ZIP files take care to include all files as mentioned above and preserve the directory structure relative to the tfr or tff file within the ZIP file Instead of shipping files you can also pass Form Layouts in BASE64 encoded strings TFORMer SDK is able to handle BASE64 strings which contain a Form Layout or even a complete Repository The files for the Form Layout or Repository may also be zipped including all required image files before being BASE64 encoded Pass the BASE64 encoded strings with the prefix BASE64 instead of filenames to the TFORMer SDK functions WWW TEC IT COM Page 51 of 53 Appendix E Distribution and Deployment Linux or UNIX E 1 Core Requirements If you want to use the TFORMer SDK within your own application or on the command line you have to distribute the files listed below libTFORMer7 so must be accessible through the library search path TFORMer xml should be located in usr local share TFORMer otherwise the path to the file must be specified with TFORMer_SetConfigFile tfprint ini should be located in usr local share TFORMer alternatively the license information can also be set through the API functions Furthermore the following libraries are required on the target system LibXml2 LibXsit FreeType2 FontConfig ZLib LibArt_LGPL opt
34. e resources allocated using the dispose method The general Java code for using TFORMer SDK looks as follows This code snippet demonstrates the basic steps for using the TFORMer SDK from within Java Take care to include the TFORMer Java library in your project and to include the TFORMer SDK and JNI DLL shared library into the java library path Import keom cect TEORMe n A import com ceci EORMer Enumerations import com tecit TFORMer Printing JobDataRecordSet import Com teeit 1EORMer Printing Job import com tecit TFORMer Printing JobDataRecordSet Record private void printWithJTFORMer throws TFormerException WWW TEC IT COM Page 26 of 53 create objects for a job and a datasource NOTE the constructor can generate an exception if the TFORMer SDK is not accessible java library path doesn t contain the TFORMer DLLs or shared libraries Job job new Job JobDataRecordSet datasource new JobDataRecordSet try connect the datasource with the job job setJobData datasource select the form layout to be printed generated adjust the type and name of the output job setRepositoryName FILENAME OF YOUR_FORMLAYOUT tff job setOutputName C temp output pdf job setPrinterType EPrinterType PSFile provide data for the datafields used in the form layout Record record new JobDataRecordSet Record record setData NAME OF YOUR DATAFTELD This is
35. for PDF output gt lt media Default media size must be listed in lt DefinedMedia gt gt lt u orientation Default orientation landscape portrait SI Zeompress on Enable disable zip compression of the PDF 1 0 gt SN margan EOR Additional top margin of the page in 1 1000mm ql zmere nllert Additional left margin of the page in 1 1000mm gt SH tine ier alin agate late Additional right margin of the page in 1 1000mm lt margin bottom Additional bottom margin of the page in 1 1000mm lt l embed fonts Embed all TrueType fonts in the document O 1 gt lt i embed subset fonts Embed all Tru eType fonts as subset OT a This will usually result in smaller PDF files gt lt embed types fonts Embed all fonts as type3 fonts which are some times elas smaller but might look bad on screen 0 1 gt SZ eolormode color grayscale blackwhite gt lt simulate font styles if 1 TEORMer will simulate bold fonts for fonts gt Use that are not available as bold on this system lt PDF media A4 orientation portrait compression 1 margin top 0 margin left 0 margin right 0 margin bottom 0 embed fonts 1 embed subset fonts 0 embed type3 fonts 1 colormode color simulate font styles 1 gt lt compression method jpeg ziplauto lt jpeg all images will be jpeg compressed Sen lt zer all images are zip compressed lt auto use jpeg compression
36. grating the COM component of TFORMer SDK into a specific Microsoft Office product gt Depending on the application it may be necessary to switch to design or edit mode in order to create VBA program code gt Macros must be activated enabled Word Excel gt The security settings of the container application must be adjusted to allow active content or macros Scripting has to be enabled 13 2 1 Microsoft Word Excel 2007 1 Open or create your document 2 Enable the developer tab in the ribbon Office Button Word Excel Options Show Developer tab in the Ribbon 3 Activate the Developer tab 4 Click Visual Basic to open the Microsoft Visual Basic editor Alternatively you can also use the shortcut A t F 77 5 Click Tools References and check TFORMer 7 0 SDK Type Library to insert a reference to TFORMer SDK 6 Click OK 7 TFORMer SDK may now be used with VBA 13 2 2 Microsoft Access 2007 1 Open or create your database 2 Edit or create a new form or report by clicking Create Form Design or Report Design 3 Click View Code in the Design ribbon or use the shortcut A t F 17 to open the Microsoft Visual Basic editor 4 Click Tools References and check TFORMer 7 0 SDK Type Library to insert a reference to TFORMer SDK 5 Click OK 6 TFORMer SDK may now be used with VBA WWW TEC IT COM Page 30 of 53 13 2 3 Microsoft Word 2003 Excel 2003 Open or
37. he access to the TFORMer SDK In particular the Java library is built following the NET architecture in order to maintain a simply and uniform program interface It s important that the paths of the TFORMer SDK DLL or shared library on UNIX platform and the JNI library are included into the java library path of the Java Virtual Machine so you must ensure that your system respects one of the following cases these libraries are defined into the environment variable PATH Windows LD_LIBRARY_PATH Linux and Macintosh SHLIB HPUX or LIBPATH AIX defined into the parameter Djava library path of the java command defined as system libraries Naturally the Java library JTFormer70 jar must be included in the classpath of the javac java command in order to compile and execute your projects 11 2 Outline The general steps for using the Java component of TFORMer SDK are 1 Include the com tecit TFORMer and com tecit TFORMer Printing namespaces 2 Create a job instance com tecit TFORMer Printing Job 3 Create a datasource instance with the derived classes of com tecit TFORMer Printing JobDataSource 4 Connect the job with the datasource 5 Use the setter methods of the job to define the required values e g name of the form layout output type and printer name 6 Provide or import the values for data fields via the datasource 7 Generate the required output with the print method 8 Finally free th
38. ibutable Package of the framework is available at http www microsoft com downloads details aspx FamilyID 0856EACB 4362 4BOD 8EDD AAB15C5E04F5 D 4 JAVA Requirements If you want to use the JAVA interface of TFORMer SDK the following files are required in addition JTFORMer70 jar TFORMer70JNI dlIl gt Please note The JAR file is compatible with version 1 5 and higher of the Java Runtime Edition JRE D 5 Additional Requirements for PostScript HTML Output In addition ship the following files whenever native PostScript HTML output is required These files support font handling on non Windows based output devices header ps Required only for native PostScript compatible output footer ps Required only for native PostScript compatible output template html Required only for native HTML compatible output footer html Required only for native HTML compatible output D 6 Distribution of TFORMer Document Layouts Ship your TFORMer Form Layouts as part of your application Repository based Form Layouts Ship the Repository tfr file and all subdirectories Forms Make sure to include all files xmd xml embedded images and take care to preserve the directory structure below the tfr file WWW TEC IT COM Page 50 of 53 Stand alone Form Layouts Ship all the tff file s and the corresponding xml data file s as well as embedded image files ZIP files containing th
39. ign B 4 1 3 Use of Escape Sequences e g n Newline in the Datafield Values Since TFORMer Version 6 escape sequences are not translated automatically This behavior can be adjusted via the tfprint command line see ESC yes no or via the API WWW TEC IT COM Page 43 of 53 Appendix C Configuration File TFORMer xml C 1 General The TFORMer SDK uses a configuration file which holds basic output settings suitable for most requirements This configuration file is named TFORMer xmi and is installed automatically After installation it can be adjusted to meet customized output needs C 2 Location of TFORMer xml on Microsoft Windows When using a Windows operating system the default TFORMer xmi resides in the directory C ProgramData TEC IT TFORMer 7 0 In addition TFORMer supports user specific files which override the default TFORMer Designer creates this file automatically in a user specific folder C Users USERNAME AppData Local TEC IT TFORMer 7 0 Via an API call the developer may also specify the filename of a specific configuration file which should be used C 3 Location of TFORMer xml on LINUX or UNIX When using Linux or UNIX this file is stored in the following directory usr local share TFORMer C 4 Configuration File TFORMer xml The following settings can be configured Common options Error handling for barcodes images and text elements with expressions Settings for downloading pictures
40. ion doubled output size JMB Cmd gt lt resolution resolution of the printer in dpi gt lt Header custom ZPL code that is printed before each print job gt lt ZEBRA media A4 orientation portrait compression rle scaling 0 dont dither text 1 dither mode 0 resolution 203 gt lt Header gt MMT lt Header gt lt ZEBRA gt lt Settings for Barcode Printing on Windows Printers gt lt WINGDI gt lt drawing mode Specifies the method for printing barcodes on GDI gt lt a lime 0 Default method gt cs 1 Compatibility mode gt lt Use the GDI rectangle functions to draw bars gt AZ May result in sub optimal output quality gt lt i but is compatible to all printers gt lt 2 Quality mode aa SoS Best quality Supported by most printers gt eam 3 Dual gt A combination of 1 and 2 lt gt lt TBARCODE drawing mode 1 gt lt WINGDI gt lt DEFINED MEDIA SIZES gt lt Add YOUR CUSTOM MEDIA SIZES to the list and use them in TFORMer gt lt Use them by specifying the name of the media as output tray name lt l enter the custom name directly into the tray option in TEORMer Designer gt lt All measurements are specified in 1 1000 millimeters gt lt DefinedMedia gt lt Media name A0 width 841000 height 1189000 gt lt Media name A1l width 594000 height 841000 gt lt Media name A2 width 420000
41. ional required for image output CUPS optional required for direct printing under Linux UnixODBC optional required for SQL support E 2 C C Requirements gt Please note For compiling C C projects under Linux or UNIX you need to install the FontConfig and FreeType2 development packages Try the following command to install them apt get install libfontconfigl dev apt get install libfreetype6 dev E 3 NET Requirements If you want to use the NET interface of TFORMer SDK this DLL is required TECIT TFORMer dll gt Please note For executing NET code under Linux Mono is required For more information about Mono see http www mono project com Main Page E 4 JAVA Requirements If you want to use the JAVA interface of TFORMer SDK the following files are required in addition JTFORMer70 jar WWW TEC IT COM Page 52 of 53 TFORMer70JNI dll Please note The JAR file is compatible with version 1 5 and higher of the Java Runtime Edition JRE E 5 Additional Requirements for PostScript HTML Output Ship the following files whenever native PostScript HTML output is required header ps Required for native PostScript compatible output footer ps Required for native PostScript compatible output template html Required for native HTML compatible output footer html Required for native HTML compatible output E 6 Distribution of TFORMer Document La
42. ired for image HTML and ZPL IT output Page 12 of 53 6 5 1 2 Rpm Installation Install the executables for TFORMer SDK which also include some sample applications with the following command as root user within the shell su sh TFORMer 7 0 2 1 i586 rpm bin After confirming the license agreement with yes this script installs the rom After the installation you will be asked if you want to generate a demo report 1 1 1 1 Rpm De Installation TFORMer SDK can be de installed using the commands below su rom e TFORMer 6 5 1 3 Deb Debian Installation Install the executables for TFORMer SDK including some sample applications with the following command as root user within the shell sudo su sh TFORMer 7 0 2 1 i386 deb bin After confirming the license agreement with yes this script installs the rom After the installation you will be asked if you want to generate a demo report 1 1 1 2 Deb Debian De Installation TFORMer SDK can be de installed using the commands below sudo su dpkg r TFORMer 6 5 2 HP UX tarball 6 5 2 1 Dependencies Before installing TFORMer SDK make sure to check if the following packages are available freetype 2 M 10 7364 171 23 depot libxml2 2 6 23 1364 11 23 depot gettext 0 14 5 12641 11 23 depot ib ilesi il p lomia 2 CEE expat 1 95 8 1a64 11 23 depot tens Mib nagy iR 2S Clejsiore 6 zimp IPRS aaea iE depot fontconfig 2 3 2 iapa R depot lnprconv Mo n
43. it and print forms and labels PDF Library TFORMer SDK creates high quality PDF documents based on graphical layouts Industrial Printing The built in barcode support satisfies almost all industry labeling requirements Client or Server based Reporting When it comes to web applications TFORMer SDK reduces round trips and bandwidth requirements Direct printing or PDF generation from within Microsoft Internet Explorer is supported Pre Press and Print Shop Applications Mass mailings and serial letters are created and printed within minutes 3 3 This Document The target audience of this document are software developers and system administrators The in formation in this document provides a high level introduction regarding the supported operating sys tems and the available APIs Application Programming Interfaces of TFORMer SDK For detailed information regarding programming TFORMer SDK we recommend to check out these additional documents TFORMer SDK DLL Programming Reference This document describes the DLL API Windows as wells as the shared library API Linux TFORMer SDK COM Programming Reference This document describes the COM programming interface TFORMer SDK NET Programming Reference This document describes the NET programming interface TFORMer SDK JAVA Programming Reference This document describes the JAVA programming interface TFORMer Designer User Manual This document provides an in
44. lications 15 FAQ 15 1 Linux UNIX 15 1 1 TFORMer does not work 15 1 2 TFORMer SDK does not print texts 32 bit TFORMer on 64 bit systems 15 1 3 TFORMer SDK does not print Umlauts e g AOUa6UB 15 1 4 Fonts are looking strange Errors in the generated layout 15 1 4 1 Installing True Type fonts 15 1 5 The Library libTFORMer7 cannot be found 15 1 6 TFORMer Include Files are not found 15 1 7 ZLib was not found on HP UX 15 1 8 The EURO sign does not work on AIX 15 1 9 Mono cannot find TFORMerNet assembly 16 Contact and Support Information 16 1 Free Support 16 2 How to Unlock the Demo Version 16 3 Your Feedback is Welcome 16 4 Company Contact Information Appendix A Terms and Definitions Al Form Layout A 2 Stand Alone Form A 3 Repository A 4 Project A 5 Datafield A 6 Template A 7 Datasource Appendix B Passing Data to TFORMer SDK B 1 General B 2 XML Files B 2 1 Internal TFORMer XML Format B 2 2 Generic XML Format B 2 2 1 Variant 1 B 2 2 2 Variant 2 B 2 3 Microsoft Access XML Format B 3 Text Files B 3 1 File Format B 3 1 1 Valid Column Separators B 3 1 2 Valid Line Separators B 3 1 3 Valid Text Qualifiers WWW TEC IT COM Page 3 of 53 B 4 Important Notes B 4 1 1 Empty or Missing Datafield Values B 4 1 2 Additional Datafields in an Import File B 4 1 3 Use of Escape Sequences e g n Newline in the Datafield Values Appendix C Configuration File TFORMer xml C1 General C 2 Location of TFORMer xml on Micro
45. ll 3 attributes accept the following arguments gt Sos plleyoncie Abort printing if an error occurs qe EE Ignore the error and continue printing SQ ee jengaligie Print error information instead of the component that gt ies caused the error gt lt ErrorHandling barcode error print image error print expression error print unicode font error print gt SIZZZUREPSerUReS lt Specifies how TFORMer handles requests for downloading pictures via URL gt lt URLPictures are supported on Windows systems only lt enabiled 0 1 enable disable downloading of images gt SA Semen the maximum bytes per picture allowed 0 unlimited gt SlZzZEmeout the download time in ms allowed per picture lt oO no timeout gt lt URLPictures enabled 1 size max 0 timeout 0 gt lt Hyphenation SIT Esorthyphens characters which should be treated as soft hyphens gt Qi additional to amp shy and amp 173 iiss A soft hyphen marks a point at which a word may be gt ese divided If the word is divided then a hyphen is qle displayed at the end of the line otherwise the hyphen gt Woe is not displayed gt Wom Sample amp 174 to add 2 additional softhyphens lt hyphen value which should be used to render visible gt SI soft hyphens gt lt Hyphenation soft hyphens hyphen gt lt COMMON gt lt PDF OPTIONS Configure settings
46. lution available 15 1 9 Mono cannot find TFORMerNet assembly Mono exits with the following error Program exe 3813 WARNING The following assembly referenced from Program exe could not be loaded Assembly TECIT TFORMer TFORMerNet assemblyref index 1 Version 7 0 0 0 Public Key 1b5f4306b234b83d The assembly was not found in the Global Assembly Cache a path listed in the MONO PATH environment variable or in the location of the executing assembly Solution Export MONO_PATH to include the directory containing the TFORMerNet bindings export MONO_PATH usr local lib More FAQs and hints can be found on our web site at http www tec it com support fag tformer Default aspx WWW TEC IT COM Page 35 of 53 16 Contact and Support Information 16 1 Free Support If you have questions need help or simply want to tell us about your application contact Email support tec it com Web http www tec it com support 16 2 How to Unlock the Demo Version You can unlock the demo version with a license key License keys can be obtained from TEC IT by email online order form or fax Email sales tec it com Online http www tec it com order Fax 43 0 7252 72720 77 16 3 Your Feedback is Welcome Don t hesitate to contact us let us hear your feedback If the product does not fulfill your require ments please tell us why We are highly interested in meeting the requirements of our customers 16 4 C
47. maoi Il 23 lejarene lnibars eric ple rood depot Only regu iredifronimage a HiMinnanc ae Abhi lou put A good place for downloading precompiled packages is http hpux connect org uk 6 5 2 2 Installation TFORMer SDK installation is straight forward TFORMer is distributed as tarball which includes an install script gunzip Setup TFORMer 7 0 2 HPUX1 1 23 IA64 tar gz tar xf Setup TFORMer 7 0 2 HPUX1 1 23 IA64 tar WWW TEC IT COM Page 13 of 53 cd SetupTFORMer sh install sh After confirming the license agreement with yes this script installs TFORMer After the installation you will be asked if you want to generate a demo report 6 5 3 AIX tarball 6 5 3 1 Dependencies Before installing TFORMer SDK make sure to check if the following packages are available gt Installation of the RPM package manager is a must AIX 4 3 rpm rte 3 0 59 30 fontconfig ron EVA 3 pperzon freetype2 2 1 5 1 aix4 3 ppc rpm np sml2 2620 1 euise4l 3 joyere o iejeni aione i gt A s eulse4 e ojee 5 sejonn AIX 5 x AIX 6 1 rpierte 2 0 5 0 fontconfig 2m2 BS alse pper son freetype2 2 1 7 2 aix5 1 ppc rpm Maori A G 21 2 225 2 008 am Ale E22 4b E Inbar iejpol 2 Sin NWA etl zer ppe rpm dbx s lie oe eo pee pe It is necessary to extract some libraries from their archives and create symbolic links cd opt freeware lib extract shared library and create a link ar x libfreetype a in ssi Ii
48. nformation For more information please check out the following documents Check out the TFPrint User Manual Start Menu All Programs TEC IT TFORMer 7 0 SDK Documentation TFPrint User Manual Execute tfprint h to display a detailed description of the command line parameters On Linux UNIX type man tfprintto display the man pages Check out the TFORMer Designer User Manual Start Menu All Programs TEC IT TFORMer 7 0 Documentation TFORMer Designer Manual Appendix B describes how data is provided to TFORMer SDK Appendix C describes how to adjust general output options WWW TEC IT COM Page 29 of 53 13 TFORMer SDK with Microsoft Office 13 1 Introduction Most applications of the Microsoft Office Suite are supporting the Component Object Model COM That means that COM compliant software components like the TFORMer SDK can be embedded and programmed directly as part of documents spreadsheets forms or databases The integration of COM components into the Microsoft Office Suite works completely seamlessly For example the TFORMer SDK can be embedded into Microsoft Access for printing barcode labels or generating PDF output Within the Microsoft Office suite VBA Visual Basic for Applications is used as programming language Thus the functionality of the TFORMer SDK is also accessible via VBA 13 2 Hints for Different Office Versions This section concentrates on the first steps for inte
49. o generate output you need at least 3 parameter groups the form layout command line parameter F the datasource command line parameters D DT DO the type and target of the generated output command line parameters O OT OO Page 28 of 53 12 3 Samples 12 3 1 For Microsoft Windows In the example below tfprint is used to generate a form layout MyLayout tff using the datasource MyValues txt a datasource contains values for datafields as aPDF document named Output pdf tforint F MyLayout tff D MyValues txt DT TEXT DO SC QC O Output pdf OT PDF Numerous sample applications are installed by the setup application check out the following menu entry for details Start Menu All Programs TEC IT TFORMer 7 0 SDK Examples Command Line Printing 12 3 2 For LINUX and UNIX 12 3 2 1 Generate all Templates as PDF In order to generate all form layouts stored in the Templates directory as PDF files execute the following script sh usr local share TFORMer Demos DemoPDF sh The resulting PDF files are created in your current working directory The generated PDF files will need about 60 MB of disc space 12 3 2 2 Generate Barcode Labels PDF Output This script generates barcode labels as PDF file sh usr local share TFORMer Demos DemoBarcodeLabels sh The layout for the label is stored in the demo repository The result is created in your current working directory 12 4 More I
50. ompany Contact Information TEC IT Datenverarbeitung GmbH Address Hans Wagner Str 6 AT 4400 Steyr Austria Europe Phone 43 0 7252 72 720 Fax 43 0 7252 72 720 77 Email support tec it com Web http www tec it com AIX is a registered trademark of IBM Corporation HTML DHTML XML XHTML are trademarks or registered trademarks of W3C World Wide Web Consortium Laboratory for Computer Science NE43 358 Massachusetts Institute of Technology 545 Technology Square Cambridge MA 02139 JAVA is a registered trademark of Sun Microsystems Inc 901 San Antonio Road Palo Alto CA 94303 USA JAVASCRIPT is a registered trademark of Sun Microsystems Inc used under license for technology invented and implemented by Netscape Microsoft Windows Microsoft Word Microsoft Excel are registered trademarks of Microsoft Corporation Navision is a registered trademark of Microsoft Business Solutions ApS in the United States and or other countries Oracle is a registered trademark of Oracle Corporation PCL is a registered trademark of the Hewlett Packard Company PostScript is a registered trademark of Adobe Systems Inc SAP SAP Logo R 2 R 3 ABAP SAPscript are trademarks or registered trademarks of SAP AG in Germany and in several other countries All other products mentioned are trademarks or registered trademarks of their respective companies If any trademark on our web site or in this document is not marked as
51. our project Choose menu View ClassWizard to enter the Class Wizard Choose the button Add Class From a type library and select TFORMerCOM7O0 dil from the installation path of TFORMer Bin subdirectory Now the type library is read from this DLL and the implemented classes Job IDataSourceRecordSet are displayed in the Confirm Classes dialog Proceed with OK After this step you can see the new TFORMer COM classes in the ClassView Include the generated header file tformercom70 h into your cpp file TFORMer SDK may now be used in your MFC application 7 3 3 Other Development Environments Please refer to the documentation of your development environment 7 4 Site Locking in MS IE Using the TFORMer SDK COM component within Microsoft Internet Explorer is restricted by Site Locking This prevents potentially harmful websites from damaging your local system e g by over writing system files on your local hard drive Site locking restricts the use of an ActiveX control to a predetermined list of domain names or security zones As long as a specific domain or protocol is not unlocked in the registry the TFORMer COM component cannot be used within Microsoft Internet Explorer gt For details please refer to the TFORMer SDK Developer Reference see section Introduction Security WWW TEC IT COM Page 17 of 53 7 5 More Information For more information please check out the following documents and
52. peg lt collormode color grayscale blackwhite o lt dither mode Specifies how images are converted to black amp white gt alan Applies only if colormode blackwhite gt 0 Use scatter dithering simulates grayscale SS 1 Use ordered dithering simulates grayscale gt Sm 2 Use threshold dithering results in b amp w only gt lt IMAGE media A4 orientation portrait resolution 200 anti aliasing 1 jpeg quality 80 tiff compression nocomp colormode color dither mode 0 gt lt ZEBRA OPTIONS Configure options for Zebra ZPL output lt media Default media size must be listed in lt DefinedMedia gt gt lt orientation Default orientation landscape portrait lt compression mage compression for graphics embedded in ZPL gt giles none no compression data is hex encoded gt lt l rle data is run length encoded SS png data is png and base64 encoded gt SI zdomVierdhicherztexzt Text will always be drawn black no dithering occurs gt Qos This leads to improved text quality o lt dither mode Specifies how images are converted to black amp white gt gel 0 Use scatter dithering simulates grayscale gt glec Use ordered dithering simulates grayscale SI 2 Use threshold dithering results in b amp w only gt ST zsealemng Resolution mode of the Zebra printer device SO 0 normal resolution JMA Command a 1 half resolut
53. pplication which uses the shared library is installed in usr local share TFORMer SampleCode This C code generates a PDF file with barcode labels The sample application uses the same docu ment layout as the script DemoBarcodeLabels sh mentioned in section 12 3 2 2 Datafield values are passed programmatically Compile it by executing gcc TFORMerSimpleX c o TFORMerSimpleX lidl ITFORMer7 L usr local lib I usr local include 10 5 More Information For more information please check out the following documents and sample applications DLL Programming Reference Start Menu All Programs TEC IT TFORMer 7 0 SDK API References DLL Programming Reference Sample Applications with source code Start Menu All Programs TEC IT TFORMer 7 0 SDK Examples Programming Appendix B describes how data is provided to TFORMer SDK Appendix C describes how to adjust general output options WWW TEC IT COM Page 25 of 53 11 Java Component 11 1 Introduction The Java component of TFORMer SDK is a Java Native Interface JNI software layer between the TFORMer SDK DLL Shared Library and the Java Virtual Machine The architecture of this wrapper is composed by The library TFORMer70 DLL or shared library in order to execute the TFORMer SDK The JNI library TFORMer70JNI DLL or shared library to translate the Java calls to the TFORMer SDK requests and responses The Java library TFormer70 jar to simplify t
54. rary libTFORMer7 a This is the static library version of TFORMer SDK After the shared library of TFORMer SDK has been installed the include files TFormer7 h and TECITStd h are stored in usr local include usr local include TECITSTd Make sure the compiler and the linker are able to locate these files Compile and link your applicati ons with a command similar to the following see also the shell script build_sample sh gcc TFORMerSimpleX c o TFORMerSimpleX Idl ITFORMer7 L usr local lib I usr local include 10 3 Outline The general steps for using the shared or static library are ii Make sure to define TECIT_DLLIMPORT and _TEC_UNIX and TEC_UNIX_BUILD Depending on your platform define TEC_LINUX TEC_FREEBSD TEC_AIX TEC_HPUX TEC_SOLARIS TEC_OS400 or TEC_SCO Only one platform is allowed Include TECITStd h and TFormer7 h Initialize the TFORMer Shared Library and save the handle TFormer_Init Select the form layout to be printed TFormer_SetRepositoryName Select the type of the output and the target file or device TFormer_SetPrinterName Provide values for datafields if any in the form layout Generate or print the output TFormer_Print De initialize the TFORMer Library TFormer_Exit 9 vo NRW WWW TEC IT COM Page 23 of 53 The general C code for using TFORMer SDK looks as follows This is not a complete application It is just a sample without any error handling to demonstrate
55. rd gt lt Record Copies 1 gt lt V Name DataFieldNamel gt Value lt V gt lt V Name DataFieldName2 gt Value lt V gt lt V Name DataFieldName3 gt Value lt V gt lt Record gt lt Records gt lt ImportedVariables gt lt Form gt lt PSData gt Description Name Description PSData This is the root element It encloses all data within the xml file Form This element encloses all data records for one Form It must be specified only once in WWW TEC IT COM Page 39 of 53 an XML file Records This element encloses all data records to be printed with the enclosing Form Must be specified only once in an XML file Record This element encloses all datafields for one record For each record there is one optional attribute named Copies The default value if the attribute is missing is 1 meaning that this record is used once If you want to use the same data for multiple records you can specify the number of record copies in this attribute V Data Element This element consists of the datafield name attribute Name and the actual datafield value DataFieldName Name of the datafield must be unique within a record Value The actual value of the datafield ImportedVariables Used internally by TFORMer B 2 2 Generic XML Format The generic XML file allows two variants see below B 2 2 1 Variant 1 lt Root gt lt Records gt lt Re
56. rmer SetVarValue hTForm NAME OF YOUR_DATAFIELD Value of the datafield fie Sieeheie PEINER i TEormer Print hivorm VE ze LE ORMe ra TFormer Exit hTForm 9 4 More Information Check out the following documents and sample applications for more information DLL Programming Reference Start Menu All Programs TEC IT TFORMer 7 0 SDK API References DLL Programming Reference Sample applications with source code Start Menu All Programs TEC IT TFORMer 7 0 SDK Examples Programming Appendix B describes how data is provided to TFORMer SDK Appendix C describes how to adjust general output options WWW TEC IT COM Page 22 of 53 10 Shared Library 10 1 Introduction A shared library on Linux or UNIX is the counterpart to a DLL on Microsoft Windows Such a library offers its functionality via a documented interface to applications All programming languages on Linux UNIX are able to use shared libraries gt Please note The shared library is only available on Linux UNIX If you need to use a similar interface on Microsoft Windows please use the DLL see chapter 9 10 2 Compiling Your Own Applications The following files are required to build your own applications with the shared library TFormer7 h This is the include file for the TFORMer SDK shared library API TECITStd h An additional include file for Linux UNIX libTFORMer7 so This is the shared lib
57. s Simply copy the required fonts ttf to the directory usr share fonts local or to the fonts sub directory of the users home e g home user fonts Then run fc cache The fonts are always installed for the user who runs the fc cache command Make sure this is the same user which uses the TFORMer SDK Check out the man pages of your system for an exact description of the fontconfig commands 15 1 5 The Library libTFORMer7 cannot be found Make sure the shared library libTFORMer7 a can be found by the linker Usually this library is installed in usr local lib Some platforms require that you add this path to your linker options e g L usr local lib 15 1 6 TFORMer Include Files are not found Make sure the TFORMer include files can be found by the compiler Usually these files are installed in usr local include Some platforms require that you add this path to your compiler options e g I usr local include 15 1 7 ZLib was not found on HP UX When creating PDF files the following warning is displayed Warning ZLib was not found Compression support will be disabled When you see this warning message an uncompressed PDF file will be created On HP UX make sure that the directory containing libz so is in your SHLIB_PATH environment variable export SHLIB_PATH usr local lib hpux32 15 1 8 The EURO sign does not work on AIX This is a known bug of the TFORMer SDK on AIX Currently there is no so
58. sample applications COM Programming Reference Start Menu All Programs TEC IT TFORMer 7 0 SDK API References COM Programming Reference Sample Microsoft Excel Spreadsheet using TFORMer SDK Start Menu All Programs TEC IT TFORMer 7 0 SDK Examples Microsoft Office WWW TEC IT COM Page 18 0f 53 8 NET Component 8 1 Introduction The TFORMer SDK NET component is perfect suited for application development with any NET programming language or Mono on Linux UNIX On Microsoft Windows the setup application installs the TFORMer assembly automatically in the GAC Global Assembly Cache and in the Bin subdirectory of the TFORMer SDK default installation path The NET classes can be used immediately with development environments like Microsoft Visual Studio On Linux the setup scripts are installing the suitable Mono bindings automatically Please note that the NET developer reference is only available in the Windows installation gt On Microsoft Windows the TFORMer SDK NET component requires NET 2 0 or higher gt On Linux UNIX TFORMer SDK for NET works with Mono 1 2 3 or higher Mono is the open source equivalent for NET 8 2 Outline gt When establishing a reference the name of the NET component is TFORMer 7 0 SDK file TECIT TFORMer dll The general steps for using the TFORMer SDK NET assembly are Establish a reference to TFORMer 7 0 SDK Depending on
59. soft Windows C 3 Location of TFORMer xml on LINUX or UNIX C 4 Configuration File TFORMer xml Appendix D D 1 Distribution and Deployment Microsoft Windows Core Requirements COM Requirements NET Requirements JAVA Requirements Additional Requirements for PostScript HTML Output Distribution of TFORMer Document Layouts Appendix E Distribution and Deployment Linux or UNIX E 1 Core Requirements C C Requirements NET Requirements JAVA Requirements Additional Requirements for PostScript HTML Output Distribution of TFORMer Document Layouts 1 1 Table of Figures Figure 1 tfprint command line parameters WWW TEC IT COM 28 Page 4 of 53 2 Disclaimer The actual version of this product document is available as is TEC IT declines all warranties which go beyond applicable rights The licensee or reader bears all risks that might take place during the use of the system the documentation TEC IT and its contractual partners cannot be penalized for direct and indirect damages or losses this includes non restrictive damages through loss of revenues constriction in the exercise of business loss of business information or any kind of commercial loss which is caused by use or inability to use the product documentation although the possibility of such damage was pointed out by TEC IT EA We reserve all rights to this document and the information contained therein Reproduction use or disclosure
60. t in Development Environments 17 7 3 1 Microsoft Visual Basic 6 17 7 3 2 Microsoft Visual C C 6 17 7 3 3 Other Development Environments 17 7 4 Site Locking in MS IE 17 7 5 More Information 18 8 NET Component 19 8 1 Introduction 19 8 2 Outline 19 8 3 More Information 20 9 DLL Dynamic Link Library 21 9 1 Introduction 21 9 2 Compiling Your Applications 21 9 3 Outline 21 9 4 More Information 22 10 Shared Library 23 10 1 Introduction 23 10 2 Compiling Your Own Applications 23 10 3 Outline 23 WWW TEC IT COM Page 2 of 53 10 4 Sample Application 10 5 More Information 11 Java Component 11 1 Introduction Outline More Information 12 Command Line Application 12 1 Introduction 12 2 Outline 12 3 Samples 12 3 1 For Microsoft Windows 12 3 2 For LINUX and UNIX 12 3 2 1 Generate all Templates as PDF 12 3 2 2 Generate Barcode Labels PDF Output 12 4 More Information 13 TFORMer SDK with Microsoft Office 13 1 Introduction 13 2 Hints for Different Office Versions 13 2 1 Microsoft Word Excel 2007 13 2 2 Microsoft Access 2007 13 2 3 Microsoft Word 2003 Excel 2003 13 2 4 Microsoft Access 2003 13 2 5 Other Microsoft Office versions 13 3 More Information 14 TFORMer in Web Applications 14 1 TFORMer SDK with Web Applications on Windows 14 1 1 Client side use of TFORMer SDK 14 1 2 TFORMer SDK on a Windows based Web Server 14 1 3 Web Based Form Layouts 14 2 TFORMer SDK on Linux or UNIX Servers 14 3 TFORMer SDK on Java Web App
61. te nodes always correspond to data records Example WWW TEC IT COM Page 40 of 53 lt Root gt lt Records gt lt Record gt lt V Name ArticleName gt Chair lt V gt lt V Name ArticleNo gt 558963 lt V gt lt V Name ArticlePrice gt 110 lt V gt lt Record gt lt Record gt lt V Name ArticleName gt Desk lt V gt lt V Name ArticleNo gt 778920 lt V gt lt V Name ArticlePrice gt 150 lt V gt lt Record gt Further Data Records lt Records gt lt Root gt B 2 2 2 Variant 2 Same as variant 1 but instead of using the syntax lt V Name DataFieldName gt Value lt V gt you can specify datafield values using the following syntax lt Root gt lt Records gt lt Record gt lt DataFieldNamel gt Value lt DataFieldNamel gt lt DataFieldName2 gt Value lt DataFieldName2 gt lt DataFieldName3 gt Value lt DataFieldName3 gt lt Record gt lt Record gt lt DataFieldNamel gt Value lt DataFieldNamel gt lt DataFieldName2 gt Value lt DataFieldName2 gt lt DataFieldName3 gt Value lt DataFieldName3 gt lt Record gt Further Data Records lt Records gt lt Root gt B 2 3 Microsoft Access XML Format The XML files which are exported from Microsoft Access looks like this lt xml version 1 0 encoding UTF 8 gt lt dataroot xmlns od urn schemas microsoft com officedata gt lt tblTableName gt lt DataFieldNamel gt Value lt Data
62. th source code are also included SampleCode This sample is written in C TFORMerSimpleX c It generates barcode labels as a PDF document SampleCodeCG This web based PHP CGI sample creates PDF files from user supplied data using fforint SampleCodeNet SampleCodeNetDataSource This sample demonstrates the use of the C DLL with Mono It generates barcode labels as a PDF Document Please note This sample requires the TECIT TFORMer dll SampleCodeJava SampleCodeJavaDataSource These samples demonstrates the use of the JAVA API 6 4 Supported APIs After installation the functionality of TFORMer SDK is available via the following APIs gt Shared Library named ibTFORMer7 so or libTFORMer7 a The interface of the shared library is 100 com patible with the DLL API on Microsoft Windows gt JAVA API the JAVA interface is available in the file JTFORMer70 jar gt MONO NET API the NET interface is available in the file TECIT TFORMer dll gt Command Line Application The command line based executable is named tfprint 6 5 Platform Specific Installation Hints 6 5 1 Linux deb or rpm based 6 5 1 1 Dependencies Before installing TFORMer SDK make sure to check if the following packages are available fonccon LE Z 2S Freetype2 2 1 7 aor 2 2 18 7 Alosasike gt il s 14 eups l 1 20 or later unixODBC 2 2 11 optional only required if SOL is used libart Igpl 2 2 3 19 optional only requ
63. to install the MS CRT9 0 DLLs You can install the components with the Microsoft Visual C 2008 SP1 Redistributable Package x86 available at http www microsoft com downloads details aspx familyid A5C84275 3B97 4AB7 A40D 3802B2AF5FC2 The package installs all required runtime DLLs If you use a setup tool and your installer supports merge modules msm files you can add the required msm packages to your setup Microsoft_VC90_CRT_x86 msm policy_9 0 Microsoft_VC90_CRT_x86 msm Please note TFORMer 7 0 0 Requires Microsoft Visual C 2008 SP1 Redistributable Package x86 Please contact TEC IT Support if you need help Depending on the requirements of your application also the following files may be needed as part of your distribution WWW TEC IT COM Page 49 of 53 D 2 COM Requirements If you want to use the COM based interface of TFORMer SDK the following DLL is required in addition TFORMerCOM70 dil This DLL provides the COM interface mark TFORMerCOM70 DLL as self registering file or use regsvr32 exe TFORMerCOM70 d11 D 3 NET Requirements If you want to use the NET interface of TFORMer SDK the following DLL is required in addition TECIT TFORMer dil This DLL provides the NET interface it is installed by default in the GAC as well as in the Program Files folder Please note For executing NET code the Microsoft NET Framework 2 0 or higher is requi red A Redistr
64. uts to certain printer models or databases The output is dynamically controlled by means of layout properties conditional printing tray control and individual computations 4 6 Cross Platform TFORMer SDK was designed to cover all operating systems in common use It is available for Microsoft Windows and for major Mac OS Linux UNIX variants 1 Due to the nature of HTML some output features may be limited or not available WWW TEC IT COM Page 7 of 53 4 7 Small Footprint High Performance TFORMer SDK provides high performance PDF and printer output in combination with very low system requirements only 20 MB hard disc space required on Microsoft Windows WWW TEC IT COM Page 8 of 53 5 Installation on Microsoft Windows 5 1 Introduction This chapter describes the installation of TFORMer SDK on Microsoft Windows The setup application comes as MSI file Microsoft Windows Installer MSI setups can be installed without any additional tool on Windows XP Windows Vista Windows 7 Windows Server 2003 Windows Server 2008 Windows Server 2008 R2 or higher The TFORMer SDK core components do not rely on NET 2 0 but TFORMer SDK ships with some NET based components like a NET assembly NET sample applications and the printing tool TFORMer QuickPrint If you are interested in these features install the NET 2 0 runtime before installing TFORMer SDK TFORMer SDK is available for 32 bit and 64 bit
65. vailable for Microsoft Windows 6 2 General The default installation path of TFORMer SDK is usr local The TFORMer SDK Command Line Application tfprint is installed into usr local bin t print All configuration files the license file tfprint ini and sample applications are located in the following directory usr local share TFORMer This directory contains the following subdirectories Templates contains ready to use layout templates designed with TFORMer Designer Examples contains folders with sample source code see section 6 3 Demos contains sample shell scripts which demonstrate the use of tfprint see chapter 12 Credits this folder holds license information for used 3 party software APIDocs C C API reference Java JAVA API reference and JAR file The include files needed for software development are stored in usr local include usr local include TECITSTd The developer documentation is available by opening index html with your browser in usr local share TFORMer APIDocs usr local share TFORMer java APIDocs Additional documentation is available through a man page man tfprint WWW TEC IT COM Page 11 of 53 WWW TEC IT COM 6 3 Sample Applications The directory usr local share TFORMer Examples contains a sample repository in the directory Demo Repository the forms contained in this repository are used by sample applications Sample applications wi
66. xt elements are not shown Most likely this problem occurs if you are using a 32 bit build of TFORMer on a 64 bit system Please make sure iconv gconv character set conversion is installed correctly Re Install glibc 32bit using yast to solve the problem 15 1 3 TFORMer SDK does not print Umlauts e g U If you are using a text file for data import e g with tfprint and if this file was generated on Win dows TFORMer is not able to print special characters like A or U To avoid this problem use XML import files this is the recommended way Another possibility is to convert the text file with iconv to UTF 8 TFORMer SDK uses UTF 8 internally on Linux Unix platforms iconv f Windows 1252 t UTF 8 o output csv input csv 15 1 4 Fonts are looking strange Errors in the generated layout When generating output TFORMer tries to match fonts available on your system with fonts used in the form layout Most likely the form layout uses Windows based fonts like Arial which are not available on your box If an exact font matching is not possible the output may look strange In order to avoid this behavior install the required fonts on your Linux UNIX machine Use the following commands which are part of the fontconfig package to install new fonts fc list list all of the fonts currently available on your box fc cache add additional fonts WWW TEC IT COM Page 34 of 53 15 1 4 1 Installing True Type font
67. youts See section D 6 WWW TEC IT COM Page 53 of 53
68. youts in all projects A 6 Template A template is a document layout which has been stored in the template database of TFORMer Designer If you select New Form in TFORMer Designer you can start your actual document layout based on such a template TFORMer Designer is shipped with various predefined templates like industry compliant labels The user can also create his own templates by saving them to the template database Templates are stored per default in the following directory Windows 2000 and Windows XP C Documents and Settings All Users Application Data TEC IT TFORMer 7 0 Templates Windows VISTA C Program Data TEC IT TFORMer 7 0 Templates This directory can be changed by modifying the registry see TFORMer Designer User Manual gt Do not edit the files in the template path directly A 7 Datasource Dynamic data is provided by external datasources like in memory datasources ODBC databases text files XML files or user input Whenever printing a form TFORMer Designer imports the data from the datasource and generates the output based on this data The same data set may be used for the next output session without importing it again the only exception is an in memory data source In this case data is not stored by TFORMer WWW TEC IT COM Page 38 of 53 Appendix B Passing Data to TFORMer SDK B 1 General During runtime your application supplies data to TFORMer SDK in order to provide v

TFORMer SDK Developer Manual V7.0

Contents

Download Pdf Manuals

Related Search

Related Contents