Home
        View the CABS Viewer Engine Users Manual
         Contents
1.                                       The license file will be delivered to the Contact E Mail Address  The license file must be  installed in the CABS Viewer install directory as 1icense dat and must be owned by  root     Feb 2008 Page 27 version 1 8    CABS Viewer Engine User   s Manual       For reporting CABS Viewer product problems       Customer specific information       Your Name        Your Company Name        Your Telephone Number        Your E mail Address        Your CABS Viewer product and version        Your CABS Viewer platform        Any software add ons to your CABS Viewer system        A detailed description of the problem        The sequence of steps that led to the problem        Actions you have taken to diagnose or resolve the problem        This Problem Report Form may be faxed to Lymeware Corporation at  240  218 7363  or the same information may be e mailed to sales lymeware com     Copyright    1999 2007 Lymeware Corporation  All rights reserved  Permission to copy for use in CABS Viewer Engine installation is granted       Feb 2008 Page 28 version 1 8       CABS Viewer Engine User   s Manual Appendix    Appendix B   Example Code    This example code is provided in platform specific download packages        cvedll h   CABS Viewer Engine DLL header file        H Copyright  c  2003 2007 Lymeware Corporation  All Rights Reserved      THIS IS UNPUBLISHED PROPRIETARY SOURCE CODE OF LYMEWARE  CORPORATION      The copyright notice above does not evidence an
2.       CABS Viewer Engine         Carrier Access Billing System  BOS BDT File Format  and Reporting Utility    User   s Manual    Version 1 8       CABS Viewer  Engine  mm    CABS BOS BDT File Format  and Reporting Utility  User   s Manual    Version 1 8    Lymeware Corporation  Post Office Box 1027  Old Lyme  Connecticut USA 2008 18 CVEUM 0018    CABS Viewer Engine User   s Manual Preface    CABS Viewer and CABS Viewer Engine are trademarks of Lymeware Corporation   Carrier Access Billing System  CABS  and Billing Output Specifications  BOS    are copyrighted works of Telcordia Technologies    Netscape   is a registered trademark of Netscape Communications Corporation    Solaris     is a trademark of Sun Microsystems Inc    Red Hat  Red Hat Network  the Red Hat  Shadow Man  logo  and RPM are   trademarks or registered trademarks of Red Hat  Inc    Linux   is a registered trademark of Linus Torvalds   Windows 2000 TT  Windows XP     Windows Vista   and Microsoft Excel     are trademarks  of Microsoft Corporation     All products and services mentioned in this  Document are identified by trademarks or  service marks of their respective companies  or organizations and Lymeware Corporation  disclaims any responsibility for specifying  which marks are owned by which companies  or organizations     CABS Viewer     and CABS Viewer Engine      software is    Copyright 2003 2008 Lymeware Corporation   Old Lyme  Connecticut  USA     CABS Viewer     and CABS Viewer Engine      Software 
3.     How to Get Help    This chapter explains how to contact Lymeware Product Support if you  need assistance with your CABS Viewer product     Scope of Support Services    Lymeware Product Support can provide assistance and information for the  following     Installing the CABS Viewer product   CABS Viewer product questions   Software revisions and upgrades   Implementing a specific feature   How to use the CABS Viewer product   The status of your support call   Requests for product enhancement  Unfortunately  we cannot assist you with problems involving the following   but we may be able to suggest a next step or another vendor to call    Your hardware   Your operating system or other system software   Your application or user written programs   Software not developed by Lymeware Corporation    Scripts written by Lymeware consultants  partners  or other third  parties    Try this first    Before you call Lymeware Product Support  use your software manuals   including this manual  to locate the section that documents the program  or feature where you are having problems  The documentation may  explain the software   s behaviour or give you insight to help you solve the  problem     Feb 2008 Page 24 version 1 8    CABS Viewer Engine User   s Manual    Contact Lymeware Product Support    Two e mail addresses are available for CABS Viewer product support or  to report a potential bug in the software or documentation  Please use the  following addresses     Support lymeware com f
4.  CVE Shared Library    To compile the full CVE shared library with our supplied example code              gcc  o full cve dll  cve dll c  L   lcvengine          We recommend that the CVE shared library be located in  usr local lib  and that LD LIBRARY  PATH be used to allow shared library discovery   For example     LD LIBRARY  PATH  LD  LIBRARY  PATH  usr local lib    Building CVE on Windows    Lymeware recommends Microsoft Visual C    Reference platform was  Windows XP Pro SP2 with Visual C   6 0 SP5  for CVE development on  all Windows platforms     Building with the CVE Dynamic Link Libraries  DLLs     The supplied example code for the Windows target platform consists of a  single Visual C   6 0 workspace with four separate C and C   example             projects   Project Description  cve_c_dll C project that links to full CVE DLL             Feb 2008 Page 22 version 1 8    CABS Viewer Engine User   s Manual                   cve cpp dll C   project that liks to full CVE DLL  test cve c dl C project that links to test CVE DLL  test cve cpp dl C   project that liks to test CVE DLL       For each project you will only need to clean build run to test each binary   Note  the full CVE DLL binaries will reguire a valid license to run correctly     We recommend that the CVE DLL should be installed in the  system     root  system32 directory in your production application or product  e g   C  Windows system32      Feb 2008 Page 23 version 1 8    CABS Viewer Engine User   s Manual
5.  The CABS Viewer  User Guide     Feb 2008 Page 7 version 1 8    CABS Viewer Engine User   s Manual    A Note on Versioning    CABS Viewer Engine uses the version nomenclature of M N  where M is  the major release version and N is the minor release number  This  arrangement matches the leading part of a CABS Viewer version of  M N B R  CVE releases and version numbers are aligned with CABS  Viewer commercial product releases and versions  and support the same  BOS version as the matching CABS Viewer   For example  CABS Viewer  Engine 1 5 supports BOS 44  just like CABS Viewer 1 5 44 0 does     Feb 2008 Page 8 version 1 8    CABS Viewer Engine User   s Manual    Introducing CABS Viewer    The CABS Viewer product line  which includes both the CABS Viewer and  the CABS Viewer Engine products  enables organizations to efficiently  format  organize  and display information on all aspects of their carrier  access billing data  This same billing data  once in a usable form  can  now be inserted in to databases  used in spreadsheets to generate  reports  or imported into existing accounting or billing systems     The major benefits of the CABS Viewer products are     Choice of Platform Support     Supports the platforms you use  including Microsoft Windows  Sun  Solaris  and several Linux distributions  including Red Hat  Enterprise Linux    Operation is exactly the same  regardless of platform   Simple to use and easy to operate    Enabling Downstream Billing Automation     CABS View
6.  to your own distribution   s  package installation instructions     If installing from Red Hat  perform the following tasks   e Login as root  e In abash shell  run up2date  or yum if running RHEL 5 or newer        up2date gcc             or             yum install gcc       This will install the latest version of gcc on your system     Building with the test CVE Shared Library    To compile the test CVE shared library with our supplied example code                    gcc  o test_cve_dll  cve_dll c  L  leve_test       Building with the full CVE Shared Library    To compile the full CVE shared library with our supplied example code              gcc  o full cve dll  cve_dll c  L   lcvengine          We recommend that the CVE shared library be located with your final  binary and that LD LIBRARY  PATH be used to allow shared library  discovery  For example     Feb 2008 Page 20 version 1 8    CABS Viewer Engine User   s Manual    LD_LIBRARY_PATH  LD_LIBRARY_PATH  path to your bin    Building CVE on Solaris    The newest versions of Solaris have GCC preinstalled and will not need  any special installation to use the included GCC scripts     To test for this  type the following in a shell window        gcc  v             If GCC is correctly installed  a message similar to the following shall be                                                 returned    This Reading specs from  usr lib gcc u6 sparc    solaris 3 4 4 specs   Configured with   gcc gcc 3 4 4 gcc 3 4 4 1 configure  verb
7. L output format   common Print common block for each BDT record   debug Display debug messages to standard out  screen    database Display CSV records in database format   recno Display BDT record numbers   number Number the displayable field labels   raw Display raw BDT records   noheader Do not display output header   summary Print a BDT summary report   summarydetail  Print a BDT summary detail report   types Display BDT Record type descriptors   uppercase Force field descriptions to UPPERCASE   billrecords Display only the Billing records  10 XX XX   detailrecords   Display only the Detail Billing records  30 XX XX   EECH e only the Customer Service Records  CSR  records  40 XX    Table 2  Command Line Options  CSV Set output format to CSV  comma delimited format    TEXT Set output format to ASCII text  default    HTML Set output format to HTML  webpage    XML Set output format to XML   Table 3  Output Format Values   Feb 2008 Page 32 version 1 8    CABS Viewer Engine User   s Manual Appendix    Appendix D   License Error  Codes    The Lymeware license routine produces a purposeful ambiguous error  message for all license errors  Only the license error code changes        Error   Reason Solution  Code                               Feb 2008 Page 33 version 1 8    CABS Viewer Engine User   s Manual Appendix    Appendix E   GLOSSARY    ATIS   Alliance for Telecommunications Industry Solutions   BDT   Billing Data Tape     BOS   Billing Output Specifications  details the spec
8. Output  BOS File File    Figure 4  CABS Viewer Engine Usage                               So by using only two function calls to the CABS Viewer Engine DLL or  shared library  you can process all of your CABS BOS BDT data files with  all the options and power of our CABS Viewer product     CABS Viewer Engine API Details    The CABS Viewer Engine Application Programming Interface  API  is  identical regardless of your development environment     Feb 2008 Page 15 version 1 8    CABS Viewer Engine User   s Manual    The current API consists of three library calls and a options structure   which is populated to request specific BOS file processing options     The library calls are in ANSI C format and may be accessed with other  programming languages  if correctly ported or supported in ANSI C format     All of the API function calls prototypes and the options structure are  located in either the cved11 h header file or the cve_shared h header  file  included in the CABS Viewer Engine distribution      The CABS Viewer Engine API Details    The API uses the following three function calls           EXPORT int cvengine char  infilename  char  outfilename   options E ODE TOAS Es    EE enee                OR Aat LIAM AE OAAS  Oper ons OO MOMIS MG          cvengine    function call details    The cvengine function is the core of the CABS Viewer Engine API and  does most of the actual work in converting the input BOS formatted file  into a CABS Viewer output formatted file  The supporte
9. d formats include  text  csv  xml  html and db  as set in the options structure      The infilename argument is a NULL terminated string containing a full  path to the BOS input file     The outfilename argumentis a NULL terminated string containing a full  path to the output file  This location must be writable by the process user  for both file creation and file writing    The options argumentis a pointer to an options structure  which has  been previously populated with the init  options    call  These options  will be used during CABS Viewer processing     This function returns 0  zero  on success and the following on failure      1 Error encountered during BOS file processing    Feb 2008 Page 16 version 1 8    The    CABS Viewer Engine User   s Manual    init_options    function call details    The init  options    function is used to populate the options  structure with standard settings to be used by the CABS Viewer Engine     The options argument is a pointer to a local options structure  These  options should be passed to the cvengine    function and will be used  during CABS Viewer processing     This function returns 0  zero  on success and the following on failure      1 Error encountered during structure inititalization    dump  options    function call details    The dump  options    function is used to display the contents of the  current options Structure     The options argumentis a pointer to an options structure  which has  been previously populated with th
10. d with and supports a variety  of development environments  The following environments are  known to work with it     o GCC  amp  G   on the Linux target environment  as a shared  library     o GCC  amp  G   on the Solaris target environment  as a shared  library     o Microsoft Visual C   6 0 and Visual C   2005 and higher    www microsoft com    Feb 2008 Page 11 version 1 8    CABS Viewer Engine User   s Manual    Installing CABS Viewer Engine    The CABS Viewer Engine product is available for    e Linux on ia32 Intel x86  reference platform is Red Hat Enterprise  Linux 4 x86 version     e Sun Microsystems Solaris on UltraSPARC  reference platform is  Solaris 10 SPARC version   and   e Microsoft Windows on ia32 Intel x86  reference platform is  Windows 2000 Service Pack 4 x86 version     A typical CABS Viewer Engine installation consists of three actions   1  Download the correct install package from the Lymeware website  or request the correct package from Lymeware Sales   2  Perform the platform specific package installation tasks  as detailed  below    3  Request and install the license key  The pre installation checklist consists of     o Print out this manual    a Install the development environment on the target machine       a Be sure the target machine has Internet access or download the  install package on another Internet enabled machine    a Complete the License Request form  see Appendix A     Additionally  proceed to the correct platform installation section be
11. e init  options    call     This function returns 0  zero  on success and the following on failure      1 Error encountered during structure processing    options Structure    The options structure can be used to set specific processing options   including output file format  for the cvengine    function call     The options structure will be found in either the cved11 h header file or  the cve  shared h header file     Feb 2008 Page 17 version 1 8    CABS Viewer Engine User   s Manual                                        typedef struct options_tag       output format values   define FORMAT TEXT 0     t   text       define FORMAT  CSV 1  A 550 1  tdefine FORMAT  HTML 2     w   html     tdefine FORMAT  XML 3     x   xml     inte display Bili      1   billrecords     int display  detail      3   detailrecords     int display csr   24155 EGO KAS A  Steet eebe fj a 90 s  int print  common      C   common     ine debug fila  le o leren    int database flag      D   database     int print ver     n   recno     int numeric  flag      N   number     int print  header  e noeden  ine print raw     r   raw     int print  summary      s   summary     D   CEET Ge EE  gt  S   Summa yclet eal a  inte print MENDES      T   types     int uppercase flag    gt   gt  Uppercase 4   Ee     z   notrailer       options t              See Appendix C for a short description of options and the CABS Viewer  Users Guide for more detailed information on these options and which  options are supported in 
12. each of the output formats     Steps to CABS Viewer Engine Success    1  Install CABS Viewer Engine to your target development  platform    2  Build with the CVE test DLL or CVE test shared library with  the supplied example code  Note  this does not require a  license file    3  Build with the CVE test DLL or CVE test shared library with  your code  Note  this does not require a license file    4  Request and receive a license    5  Build with the CVE DLL or CVE shared library with the  supplied example code  Note  this does require a license file  to allow you to run the example code binary    6  Build with the CVE DLL or CVE shared library with the your  code  Note  this does require a license file to allow you to  run the example code binary    7  Done     Feb 2008 Page 18 version 1 8    CABS Viewer Engine User   s Manual    Building with CABS Viewer Engine    Instructions for building the CABS Viewer Engine  CVE  differ according to  target platform and CVE form  DLL or Shared library   The following  sections detail how to build using CVE  with our supplied example code  and your target development environment     Lymeware is available for CVE support or custom services to support    other target platforms and development environments  Contact our sales  department for more information on these opportunities     Building CVE on Linux  Testing your GCC installation    Many of the Linux distributions  including Red Hat Enterprise Linux  have  gcc and g   preinstalled and 
13. eenceeceeeeeeaaeseeneeseeeeceaeeseaaesseneeseaeeesaaesseneeesaees 27  CABS Viewer License Request Form      essesseesseessesssserreersseiesrirserissrissrinernsrnee 27  CABS Viewer Problem Report Fom    sssssssssseessesseesseesrisessesernsrnnsnnsnnnnnnrnnsrnene 28  Appendix B     Example Code        ccccsccccssscsseeeeeseeeeeneeeseaesesneeenseeeseeesesnaesenseeeeenees 29  Appendix C     CABS Viewer Engine Options                       00  nnnnnnannnnnnnanannnunana 32  Option    Descriptions niari tapu ard ta ee EE laaste 0 32    Feb 2008 Page 3 version 1 8    CABS Viewer Engine User   s Manual Preface    Appendix D     License Error Codes                   ennrnennnnnanannannnnannnananananananannnnnnanaa 33    Appendix E     GLOSSARY                      naannnnnnnennnnnanananananannannnnnnnnanannnnnanannnannnnanai 34    Feb 2008 Page 4 version 1 8    CABS Viewer Engine User   s Manual Preface    Figures    Figure 1  CABS Viewer in Action              Figure 4  CABS Viewer Engine Usage    Feb 2008    Page 5 version 1 8    CABS Viewer Engine User   s Manual Preface    Tables    Table 1  CABS Viewer Product Worksheets             cccccceccccesceceeeeceeeeeeeaeeeeesecseeeeseaueaseseeeeeeeaeanaeeeeeseeaead 26  Fable 2  Gommand  Line Optlons ae aa aa aa a aa Aa SEENEN eege 32    Table 3  Output Format Values    CABS Viewer Engine User   s Manual  Welcome    Thank you for using the CABS Viewer Engine  created by Lymeware  Corporation  The CABS Viewer Engine product is designed to al
14. er output can be easily shared and processed   Filter and format CABS data to your billing system   s exact input  requirements   Special CSV database format for import into most common  enterprise database management systems  including Oracle  DB2   Informix  MySQL  Sybase  and MS SQL Server    Valid well formed XML can support many standard Telecom billing  systems    Useful for Revenue Assurance     Create user friendly output  easily manipulated with Microsoft  Excel  OpenOffice Calc or several other spreadsheet products   CSV or XML data can support many standard Telecom billing  systems    Display Custom Billing Reports     CABS Viewer output is very easy to manipulate using may script  languages  including Perl  Python  and Ruby     all of which can  natively read CSV and XML data for further downstream processing  or reporting    Lymeware is also available to deliver customer specified custom  reports as an additional service     Feb 2008 Page 9 version 1 8    CABS Viewer Engine User   s Manual       Text    CABS Viewer          Figure 1  CABS Viewer in Action    CABS Viewer products are built on established server technologies and  widely support data and industry specific standards  including     e CABS BOS BDT  or Carrier Access Billing System Billing Output  Specifications Billing Data Tape record formats and data  presentment formats  the industry standard billing record transport  format     e CSV  or Comma Separated Value or comma delimited format  for  use wit
15. h most spreadsheet products and a common database  import format     e XML  or Extensible Markup Language  for input to other billing or  accounting systems or for further XSLT and XML processing  and    e HTML  Hypertext Markup Language  for display either locally or on  a web server with any standard web browser    The CABS Viewer Engine is supported on the Linux  Solaris and Windows  operating systems     Feb 2008 Page 10 version 1 8       CABS Viewer Engine User   s Manual    Getting Started with CABS Viewer    Before You Start    This guide assumes that the resources you need to access the system are  available and that you are familiar with how to use them  If you are not  sure whether your system meets the requirements or how to use required  third party tools  primarily a web browser   talk to your manager or system  administrator     Technical Requirements    Before you begin using the system  ensure that you have the appropriate  software installed and configured on your system  All you will need is        e One of the following platforms running one of these operating  systems     o Red Hat Enterprise Linux 3 or 4 or 5 on Intel  A32 x86  platforms  Other Linux distributions may also be supported    o Sun Microsystems Solaris 9 8 10 on UltraSPARC platforms    o Microsoft Windows 2000 8 XP on Intel   A32 x86 platforms   Note  Vista has not been tested at this time     e A supported development environment on your target  platform     CABS Viewer Engine has been teste
16. he following table describes each worksheet        License Request Form This form is required for issuing of  an evaluation or permanent license   required for product operation   Problem Reporting Form This form should be used for any  problems encountered which can be  reported back to Lymeware   Table 1  CABS Viewer Product Worksheets                   These worksheets may be copied for use in maintaining your CABS Viewer product     Feb 2008 Page 26 version 1 8    CABS Viewer Engine User   s Manual    License Request Form    A specific license data file will be required to run a CABS Viewer product  Lymeware or  your distributor will be able to supply a valid license file if the following information is  supplied        For requesting a valid commercial or evaluation CABS Viewer product license       Customer specific information  Customer  Company  Name     Lymeware Product Name  CABS Viewer Engine  Lymeware Product Version     Lymeware Product Options  standard   Target Machine IP Address    Target Machine Host ID  only needed for Solaris     Target Machine Make and Model    Target Machine Operating System and Version    Contact Person    Contact Phone Number    Contact E mail Address   This License Request Form may be faxed to Lymeware Corporation at  240  218 7363  or the same information may be e mailed to sales lymeware com     Copyright    2001 2007 Lymeware Corporation  All rights reserved  Permission to copy for use in CABS Viewer Engine installation is granted  
17. ific record and data  element format of the CABS standard     CABS   Carrier Access Billing System  a telecom carrier billing standard   supported by many of the major national and regional carriers     CLEC     Competitive Local Exchange Carrier     CSV     Comma Separated Values  also called command delimited format   usually supported by spreadsheet programs and as import formats for  many databases     HTML     The Hyper Text Mark up Language  The data format used to  build and describe web pages     ILEC     Incumbent Local Exchange Carrier     ITU T   International Telecommunications Union   Telecommunications  standardization sector     OSS     Operational Support System  In the Telecommunications Industry  the OSS is the sum of all in house provisioning and billing systems and  databases     RBOC     Regional Bell  system  Operating Company  The pieces of AT amp T  created to provide Local telephone service  Often referred to as the    Baby  Bells        URL     Universal Resource Locator  typically a web browser address or  location value     XML    A open data format  defined by WC3 to allow data interchange  between differing programs and platforms     Feb 2008 Page 34 version 1 8    CABS Viewer Engine User   s Manual Appendix       CABS Viewer Engine User   s Manual    Please send suggestions or corrections to     support lymeware com  Lymeware Corporation  Box 1027  Old Lyme  CT 06371 USA  www lymeware com    Feb 2008 Page 35 version 1 8    
18. is a compilation of   software of which Lymeware Corporation   is either the copyright holder or licensee     Acquisition and use of this software and   related materials for any purpose requires a   written license agreement from Lymeware Corporation  or a written license from an organization licensed   by Lymeware Corporation to grant such a license     This Manual is Copyright    2003 2008  Lymeware Corporation   Old Lyme  Connecticut  USA    All Rights Reserved     2008 18 CVEUM 0018    CABS Viewer Engine User   s Manual Preface    Contents    VTT Vu E 7  leg EU EE H  Introducing CABS Viewer                      n nsannnananannnnnnnananaananannannnnanannnanannnananannnnnanaa 9  Getting Started with CABS Viewer                          nnnnannnananannnnnanananananannnanan annan 11  Before You Stiai e en aa Ee EE eae 11  Technical Requirement   00 0 0    cece eee cess eee eeeeeceeeeeaeeseeeeeseeseaeseaeesseeseaeeseeeseeessaeseaeeseeeseeeeaeeegs 11  Installing CABS Viewer Engine          sssssssseesssssssssrrssrrssrrssrnsstnssrnnsrensressrenssenssnns 12  Bil ele ENEE TEE 13  Sun Solaris Package Installation            ceceeeeceeeeeeseeeeeeeeeeeeeeeeeeeeeeeaesaeeeeeeaeeeaeeaesneeeaeseeeeaeseeeeaeenetaes 13  Microsoft Windows Package Installaton  cece cee cee eeneeeeeeseeeeeeseeeseaeeseaeseeeseaeeeeessneenaes 13  Requesting a license key    14  Using CABS Viewer Engine                         5 n0ennnanenenanannnanannannnanananenananannnananammnaa 15  CABS Viewer Engine API De
19. low     Feb 2008 Page 12 version 1 8    CABS Viewer Engine User   s Manual    Linux Package Installation       Linux users should download the RPM version of the CABS Viewer  Engine installation file  via FTP or HTTP  The specific URL to use will be  provided by the Lymeware Sales staff     This file can be installed with the RPM command  logged in as root            rpm  i  lt rpmfile gt        This will install the CABS Viewer Engine files to  opt cve src     DL      CT l    SOLARIS  Sun Solaris Package Installation    Solaris users should download the PKG version of the CABS Viewer  Engine installation file  via FTP or HTTP  The specific URL to use will be  provided by the Lymeware Sales staff     This file can be installed with GZIP and TAR commands  logged in as  root         gzip  dc  lt tar gz_file gt    tar xvf               This will install the CABS Viewer Engine files to  opt  cve src     Microsoft Windows Package Installation       Windows users should download the ZIP file version of the CABS Viewer  Engine installation file  via FTP or HTTP  The specific URL to use will be  provided by the Lymeware Sales staff     This file can be unzipped with WINZIP or 7 UP and should be unpacked  with the    Use Folder Names    option     Feb 2008 Page 13 version 1 8    CABS Viewer Engine User   s Manual    Requesting a license key    All new users need to request a license key to operate CABS Viewer  Engine on any platform     A specific license key file will be required to 
20. low you to  embed our powerful CABS BOS record processing engine into your own  internal billing process or products     Most importantly  our CABS Viewer product line allows CLECs and other  service providers to seamlessly blend their CABS billing data in to  whatever OSS or billing system currently in use  The instructions in this  guide will introduce you to integration concepts and help you get familiar  with the fundamentals of using your CABS Viewer Engine product     About this Guide    This guide is current with the details of operation for Lymeware   s CABS  Viewer Engine  version 1 8  It is designed for developers and software  architects who are responsible for adding the CABS Viewer Engine to their  internal billing processing or product     The information in this guide describes how to link the CABS Viewer  Engine  CVE  Dynamic Linked Library  DLL  or Shared Object Library   SO  to a current application with a simple Application Programming  Interface  API      Readers are expected to have programming or software development  knowledge  and should be generally familiar with   e A target programming language  such as ANSI C  C    or Visual  C     e The use of the target compiler and linker   e Optionally  the use of a development graphical integrated  development environment  IDE   such as Microsoft   s Visual IDE or  the Eclipse IDE    For more information on the CABS Viewer Engine capabilities and details  on output options please refer to the latest version of
21. mmarydetail          t   text     int print_types      T   types     int uppercase_flag      u   uppercase          w   html          x   xml     int print_trailer      z   notrailer        options t        function to be imported exported   EXPORT int cvengine char  infilename  char  outfilename  options t  options    EXPORT int init options options t  options     EXPORT int dump options options t  options       endif    ifdef CVE DLL Hi   EOF       cve_dll c   Defines the entry point for the console application        used to test the CABS Viewer Engine DLL function       at this point the options can be modified directly       now call the main processing function with       an input file name  which must exist and be readable  and      an output file name  which should not exist and will be in a      writable location  and      the populated options structure  which dictates the processing     that should take place       Note  the default output format is TEXT  cvengine  demo_data42   demo_data42 text   amp opts    return  0         CABS Viewer Engine User   s Manual Appendix       1 EOF    Feb 2008 Page 31 version 1 8    CABS Viewer Engine User   s Manual Appendix    Appendix  Options    C   CABS Viewer Engine    CABS Viewer Engine supports the following Options to modify or select  the exact output format and content required for your application     The full form is     Option Descriptions       Switch Description  bodyonly Display only the  lt BODY gt  section of HTM
22. or all technical inquires and problem reports   including documentation issues from customers with support contracts   Customers should include relevant contact details  including company  name and phone number  in initial message to speed processing   Messages that are continuations of an existing problem report should  include the problem report ID in the subject line  Customers without  support contracts with Lymeware Corporation should not use this address   but should contact their distributor directly     Bugs lymeware com for bug reports and documentation problems     Bug reports on software releases are always welcome  These may be  sent by any means  but e mail to the bug reporting address listed above is  preferred  Please send proposed fixes and successful workarounds with  the report if possible  Additional useful information would include CABS  Viewer software version  hardware description  operating system version  and patches  screen dumps  relevant sections of logs and configuration  files  and failed messages files  Any reports will be acknowledged  but  further action is not guaranteed  Any changes resulting from bug reports  may be included in future releases     Feb 2008 Page 25 version 1 8    CABS Viewer Engine User   s Manual Appendix    Appendix A   CONFIGURATION  WORKSHEETS AND FORMS    This appendix contains worksheets that should be used to complete specific tasks  during the installation  configuration and maintenance of your CABS Viewer product   T
23. os prefix  usr      exec prefix  usr   sysconfdir  etc   libdir  usr lib      libexecdir  usr lib   man   dir  usr share man   infodir  usr share info   enable    languages c  java nable nls without included    gettext nable version specific runt   ime libs   without x nable libgcj   disable java    awt with system zlib   ena   bl interpreter disable libgcj debug nabl   threads posix nable java gc b   oehm nable sjlj exceptions nable hash   synchroniza   tion   enable libstdcxx debug    reconfigured    Thread model  posix   gcc version 3 4 4  solaris 64int   ode 0 12  using dmd   0 125               If GCC is not found using the above command  it may need to be installed   Solaris uses the PKG  Package  utilities for product installation and  management     Lymeware uses the www sunfreeware org web site for Solaris pre   packaged open source products  Surf to the site  select your specific  platform and Solaris version and download the binary package to your  local Solaris machine     Feb 2008 Page 21 version 1 8    CABS Viewer Engine User   s Manual    Once downloaded  perform the following tasks   e Login as root  e Inaksh shell  run pkgadd with the following command     pkgadd  d   lt GCC_pkg_name gt        This will install the latest version of GCC on your system     Building with the test CVE Shared Library    To compile the test CVE shared library with our supplied example code        gcc  o test_cve_dll  cve_dll c  L  lcve test                   Building with the full
24. run the CABS Viewer Engine   Lymeware will supply this license file if the following information is  supplied via email to Lymeware Sales  see Appendix A for the License  Request form      Customer Company Name    Product Name  CABS Viewer Engine   Platform   either Linux  Solaris  or Windows 2000 XP   Target Machine IP Address    Target Machine Host ID   only needed for Solaris machines   Contact Person    Contact Phone Number    Contact E Mail Address     A digital license request form is also available for completion and  submission to Lymeware  The license file will be delivered to the Contact  E Mail Address  In all cases  regardless of platform  the license key  should be renamed to license dat and copied to the same location as the  CABS Viewer Engine library  libcvengine so for Linux or Solaris or  cvengine dll for Windows      A 30 day fully functional evaluation license is available from Lymeware   s    sales department  Lymeware Sales may be contacted at  sales lymeware com     Feb 2008 Page 14 version 1 8    CABS Viewer Engine User   s Manual    Using CABS Viewer Engine    The CABS Viewer Engine is very powerful but provides a very simple    interface to allow your external billing system or product to use the power  of CABS Viewer Engine in your own solution     Regardless of your target platform and the form of your CABS Viewer  Engine  the basic operations are the same        Your Solution  CVE          Options Data       init options       cvengine  7    CABS 
25. tails  15  The CABS Viewer Engine API Details   0 0 0    eceeeeceeseseeeeeeeeeeeseeseeeeeaeseesaeeeeeaeeaeseaeeaeeeeeeaneeeeeas 16  The opt ions Te 17  Steps to CABS Viewer Engine Guccess 18  Building with CABS Viewer Engine                         nzrrnananannannnnnannnananannannnnnnnnnnn 19  Building CME On En 19  Testing your GCC installation                                imrernnrennneneannennennenenennennnenneanenaneaneanneannanane 19  Building with the test CVE Shared Library                             eenreennnreaneneneannenneanneeneenaenneanaennee 20  Building with the full CVE Shared Library                          iiernrennereennenneanneeneanenneaneenneanennnenaannee 20  Building CVE on Solaris ciie aaa eataa E EA A R E aE 21  Building with the test CVE Shared Library                             imenrreennneannneneannenneanennneenaeaneenaennae 22  Building with the full CVE Shared Library                          iierarennnenreenenneaneneneaneenneanananeanaannenaennee 22  Building CVE on Windows    22  Building with the CVE Dynamic Link Libraries  DL elt  22  How tO Get Helge Eege 24  Scope of Support Services                                m  nnnnenrnnannaaaaannaannnneanaaaaaanaaaaanne anna 24  Try this fii SUs cuanna aa AEN eege dled evel  24  Contact Lymeware Product Support                                 6 nvnnenennnnnanananananaaanaa anna 25  Appendix A   CONFIGURATION WORKSHEETS AND FORMS                        26  License Request Form  0     c ccccccccccse
26. will not need any special installation to build  the included example code     To test for this  type the following in a bash shell console        gcc  v             If gcc is correctly installed  a message similar to the following shall be                                              returned    Reading specs from  usr lib gcc 1686 pc    linux 3 4 4 specs   Configured with   gcc gcc 3 4 4 gcc 3 4 4 1 configure  verbos prefix  usr      exec prefix  usr   sysconfdir  etc   libdir  usr lib      libexecdir  usr lib   man   dir  usr share man   infodir  usr share info   enable    languages c ada ct  d f77    java objc nable nls without included gettext   enable version specific runt   ime libs   without x nable libgcj   disable java    awt with system zlib   ena   bl interpreter disable libgcj debug nabl   threads posix nable java gc b             Feb 2008 Page 19 version 1 8    CABS Viewer Engine User   s Manual                oehm   disable win32 registry nable sjlj exceptions  nable hash synchroniza  tion   enable libstdcxx debug    reconfigured        Thread model  posix  gcc version 3 4 4  linux special   gdc 0 12  using dmd  0 125  Page              If gcc is not found using the above command  it may need to be installed   Our Linux reference platform  Red Hat Enterprise Linux 3 4 5  uses RPM   the Red Hat Package Manager  for product installation and management   Your specific Linux distribution may use other package managers  If not  using Red Hat Linux and RPM then refer
27. y actual or      intended publication of such source code    Wi       Header   projRCS cabsviewer src cvedll h v 1 6 2007 01 14 12 44 36 aclark Exp       Additional Engine DLL functions for CABS Viewer         ifndef CVE DLL H  define CVE DLL H1     if CPP    1   define EXPORT extern  C    declspec dllimport    else   ifdef BUILD_DLL     the dll exports   define EXPORT __declspec dllexport    else     the exe imports   define EXPORT __declspec dllimport    endif   endif     define EXPORT       CVE types for DLL function calls  1    typedef struct options tag       configuration globals     externally set  config file  command line switches  etc      in switch ascii order  int output_format      output format values   define FORMAT_TEXT     t   text      define FORMAT_CSV     c   csv      define FORMAT_HTML     w   html      define FORMAT_XML     x   xml       int display  bill      1   billrecords     int display  detail      3   detailrecords          Feb 2008 Page 29 version 1 8    CABS Viewer Engine User   s Manual Appendix    int display_csr      4   csrrecords     int bodyonly_flag      b   bodyonly          c   csv     int print common      C   common     int debug_flag      d   debug     int database_flag      D   database     int print_recno      n   recno     int numeric_flag      N   number          o FILE   output FILE     int print_header      q   noheader     int print_raw      r   raw     int print_summary      s   summary     int print_summarydetail      S   su
    
Download Pdf Manuals
 
 
    
Related Search
    
Related Contents
Philips Water softener AC4149  LG Electronics KSM1506 Stereo System User Manual  取扱説明書ダウンロード - CLUB T-fal    第3章関係 - 国立公文書館  ADC® Instruments Neurologiques - American Diagnostic Corporation  SBC86800 Series Users Manual Version A1 September 2003  Vertex SD995 Installation Guide  User Guide - Softouch Information Services  CÓPIA NÃO CONTROLADA - International Paper    Copyright © All rights reserved. 
   Failed to retrieve file