-------------------------- Dokumentation zu Documentation for extract.exe / extract2.exe -------------------------- Dr. med. Jörg M. Sigle joerg.sigle@jsigle.com http://www.ql-recorder.com 2003-11-21 19:46 -------------------------- English version: 1.) What is extract / extract2? 2.) How do extract / extract2 work? 3.) How can I use extract / extract2? 4.) Source of further documentation 5.) Alternatives to extract / extract2 Deutsche Version: 1.) Was ist extract / extract2? 2.) Wie funktionieren extract / extract2? 3.) Wie kann ich extract / extract2 benützen? 4.) Quellen weiterer Dokumentation 5.) Alternativen zu extract / extract2 --------------------------------------------- 1.) What is extract / extract2 --------------------------------------------- extract and extract2 are two programs which can transfer data from multiple *.anq files generated with AnyQuest for DOS or AnyQuest for Windows into a single table. extract and extract2 perform a function which is similar to AnyQuest for Windows' built in "Generate export file from multiple *.anq files" function. The following differences exist: AnyQuest for Windows built in function: - Integrated part of Windows program - Made for interactive use - Optimized for easy handling - No configuration needed, works for any source *.anq files with any content - Configurability limited mainly to selection of exported sections from source files and separator characters - Output file is for general use, may need minor editing with text editor or spreadsheet before it has exact target format for some target software, like removing of unwanted columns, removing explanatory header lines, re-naming columns, reformatting numeric format and so on extract / extract2: - Standalone DOS program - Made for interactive or batch use - Optimized for flexibility - Configuration file to be used can be chosen from examples or has to be adopted according to source *.anq file content and specific target file needs - Configurability is extensive and includes complete control over exported data fields, ordering of output columns, output column headings, numeric format and other issues - Depending upon the configuration, the output file can be tailored to have exactly the content and format that can be directly processed by the target software without need for any additional editing extract is the original version with German dialogs, it shows some of the currently set options first and waits for a key to be pressed before it does the data extraction. extract2 is a version with English dialogs, it has the same functionality as extract but does not wait for any key to be pressed before it does the data extraction. Thus, it is optimal for automated batch processing environments. --------------------------------------------- 2.) How do extract / extract2 work? --------------------------------------------- Basically the extract program transfers selected data from individual *.anq files into an output file in a tabular format. The generated output file can then be imported by third party software like SAS, SPSS, Spida, MS Excel, MS Access, Star Office, Open Office, some text editors and so on. When extract is started, it first looks for a configuration file (default filename: extract.ini). It reads the settings from the configuration file and prints the name of the configuration and some major settings onto the screen. Now, extract waits for a key but extract2 doesn't. Next, the program opens the target file as specified in the configuration file for output. If specified in the configuration file, it writes a line of table column headings into the output file. Then it looks for the source files as specified in the configuration file. The name of each found source file is printed onto the screen. From each source file, the program extracts the lines containing the parameters specified in the configuration file. It interprets and optionally reformats the values according to settings from the configuration file. Afterwards, it writes a line of tabulated data into the output file. When all available source files are processed, the output file is closed and the program ends. --------------------------------------------- 3.) How can I use extract / extract2? --------------------------------------------- Copy the contents of the extract package and your source *.anq files into a directory. Review the supplied example *.ini files from the extract package. Select one that fits your source *.anq files and your desired target format and copy this example *.ini file onto extract.ini in the same directory. If it does not match your needs exactly, edit this extract.ini file so that it matches your needs. Run the extract or extract2 program and watch it process your source files. Open or import or post-process the produced output file with your target application. If you find that your produced output file does not match the requirements of your target application yet, modify the extract.ini file and continue the cycle of data extraction and output file use with the target application until the settings in extract.ini are satisfactory. Finally, add explanatory comments to your extract.ini file and copy it to a self-explanatory name so you can use it in later projects. You may also send me the *.ini file you generated for inclusion into future versions of the extract package. --------------------------------------------- 4.) Source of further documentation --------------------------------------------- The sections in AnyQuest for Windows' on-line-help related to data export into third party applications mostly also apply to the extract / extract2 programs. The following files are currently located in the directory \jmshome\qlr\document\manuals\ on the QL-Recorder information CD or in the section "Multimedia Documents, Tutorials, ..." in the WWW site: win\howto-anq2sas.html describes how to get data from *.anq files generated with AnyQuest for Windows into SAS Statistical Analysis Software using the built in export function. This also covers the alternative use of the extract program. dos\lifequa5.pdf is the German original documentation of the Quality-of-Life-Recorder solution based upon AnyQuest for DOS. It covers the original version of the extract program and contains an example for the generated output file. The supplied example configuration files contain an explanation of all configurable options, how to control these, and about enhanced functionality available in recently generated versions of extract and extract2. If you need any support after having used these sources of information, you may contact myself by e-mail or phone, or you may also contact other Quality-of-Life- Recorder users or try to get help from your local IT support staff. --------------------------------------------- 5.) Alternatives to extract / extract2 --------------------------------------------- extract / extract2 and the data export function built into AnyQuest for Windows transfer data from multiple individual *.anq files into an output file in tabular format. Typically, such an output file will contain data from multiple questionnaire administrations. If you want to process the results from a single questionnaire administration immediately and transfer it into a third party target application (e.g. an SQL data base or a practice management software), you can use AnyQuest for Windows' built in feature to call an external program either after writing an *.anq file or at any point during questionnaire presentation from within UPN formulas to immediately trigger external processing of available data. Examples for applications of this method are currently available in the software library as follows: - Seamless bi-directional intergration of AnyQuest for Windows in German practice management software environments using a standard GDT interface, implemented by the use of two small modules and configuration files - Immediate automatic transfer of results via FTP to a server, followed by conversion of an *.anq result file into an SQL statement file to be processed by the client of the Interbase database, implemented by DOS/Windows batch files and Perl scripts - Immediate postprocessing of an *.anq file to generate a corresponding *.txt file with specific content in a specific format implemented by a simple program (and complemented by another set of programs collecting patient identification data from the German Health Insurance card at the beginning of the questionnaire administration) --------------------------------------------- 1.) Was ist extract / extract2? --------------------------------------------- extract and extract2 sind zwei Programme, die Daten aus mehreren *.anq Dateien, welche mit AnyQuest for DOS oder AnyQuest for Windows erzeugt wurden, in eine einzelne Tabelle übertragen können. Dabei funktionieren extract and extract2 ähnlich wie die in AnyQuest for Windows eingebaute Funktion "Generate export file from multiple *.anq files". Die folgenden Unterschiede existieren: AnyQuest for Windows eingebaute Funktion: - Integrierter Teil eines Windows-Programms - Für interaktive Benutzung - Optimiert für einfache Handhabung - Keine Konfiguration erforderlich, funktioniert für beliebige Quelldateien *.anq mit beliebigem Inhalt - Konfigurierbarkeit beschränkt, hauptsächlich auf Auswahl exportierter Abschnitte aus den Quelldateien und Trennzeichen - Ausgabedatei für generelle Verwendung ausgelegt, mag kleinere Überarbeitung mit Texteditor oder Tabellenkalkulation erfordern, bevor sie den genauen Anforderungen an das Format entspricht, das eine Zielsoftware letztendlich verarbeiten kann. Beispiel: Entfernung unerwünschter Spalten oder erklärender zusätzlicher Zeilen im Bereich der Spaltenüberschriften, Umbenennen von Spalten, Änderung des Zahlenformats usw. extract / extract2: - Separates DOS Programm - Für interaktive oder unbeaufsichtigte Anwendung - Optimiert für Flexibilität - Erforderliche Konfigurationsdatei kann aus einer Anzahl bereitgestellter Beispiele ausgewählt werden, muß eventuell angepaßt werden an den Inhalt der Quelldateien *.anq und die spezifischen Anforderungen an das Format der Zieldatei - Umfangreiche Konfigurierbarkeit, einschließlich kompletter Kontrolle über exportierte Datenfelder, deren Reihenfolge, Spaltenüberschriften, Zahlenformat und anderer Dinge - Abhängig von der Konfiguration kann die Zieldatei so zugeschnitten werden, daß sie exakt den Inhalt und das Format hat, welches direkt von der Zielsoftware verarbeitet werden kann, ohne dass eine weitere Bearbeitung notwendig wäre extract ist die originale Fassung mit deutschen Dialogen. Es zeigt zunächst einige Einstellungen an und wartet dann auf einen Tastendruck, bevor es mit der Datenverarbeitung beginnt. extract2 ist eine Fassung mit englischen Dialogen, die die selbe Funktionalität wie extract hat, jedoch nicht auf einen Tastendruck wartet, bevor es die Daten verarbeitet. Somit is es optimal für den automatischen, unbeaufsichtigten Einsatz geeignet. --------------------------------------------- 2.) Wie funktionieren extract / extract2? --------------------------------------------- Grundsätzlich überträgt extract Daten aus einzelnen *.anq Dateien in ein Tabellenformat in einer Ausgabedatei. Die erzeugte Ausgabedatei kann anschließend von Software wie SAS, SPSS, Spida, MS Excel, MS Access, Star Office, Open Office, einigen Texteditoren usw. geöffnet werden. Wenn extract startet, sucht es zunächst nach einer Konfigurationsdatei (standardmäßiger Dateiname: extract.ini) Es liest die Einstellungen aus dieser Datei und zeigt den Namen der Konfiguration sowie einige wichtige Einstellungen am Bildschirm an. Dann wartet extract auf einen Tastendruck, während extract2 einfach weiterläuft. Anschließend öffnet das Programm die Ausgabedatei, wie in der Konfigurationsdatei angegeben. Sofern dies in der Konfigurationsdatei eingestellt ist, schreibt es eine Zeile mit Spaltenüberschriften der Tabelle in die Ausgabedatei. Dann sucht es nach Quelldateien entsprechend den Angaben in der Konfigurationsdatei. Der Name jeder gefundenen Quelldatei wird am Bildschirm angezeigt. Aus jeder Quelldatei entnimmt das Programm diejenigen Zeilen, die die in der Konfigurationsdatei angegebenen Parameter enthalten. Es interpretiert diese, und formatiert sie gegebenenfalls entsprechend den Einstellungen in der Konfigurationsdatei. Danach schreibt es eine Zeile tabulierter Daten in die Ausgabedatei. Sobald alle verfügbaren Quelldateien verarbeitet sind, wird die Ausgabedatei geschlossen und das Programm beendet. --------------------------------------------- 3.) Wie kann ich extract / extract2 benützen? --------------------------------------------- Kopieren Sie den Inhalt des extract Pakets und Ihre Quelldateien *.anq in ein Verzeichnis. Sehen Sie die bereitgestellten Beispieldateien *.ini aus dem extract Paket durch. Wählen Sie diejenige aus, die am besten zum Inhalt Ihrer Quelldateien und dem gewünschten Format Ihrer Zieldatei paßt, und kopieren Sie diese als extract.ini in dasselbe Verzeichnis. Falls die Einstellungen in dieser Datei noch nicht genau Ihren Anforderungen entsprechen, passen Sie sie weiter an. Starten Sie extract oder extract2 und beobachten Sie es beim Verarbeiten Ihrer Quelldateien. Öffnen oder importieren Sie die erzeugte Ausgabedatei oder verarbeiten Sie sie anderweitig mit Ihrer Zielsoftware weiter. Falls die Ausgabedatei jetzt den Anforderungen der Zielsoftware noch nicht genau entspricht, passen Sie die Konfigurationsdatei extract.ini weiter an und setzen Sie den Zyklus aus Datenextraktion und Weiterverarbeitung der Ausgabedatei mit der Zielsoftware so lange fort, bis die Einstellungen in extract.ini zufriedenstellend sind. Abschließend: Fügen Sie erklärende Kommentare zu Ihrer Konfigurationsdatei extract.ini hinzu und kopieren Sie diese auf eine Datei mit selbsterklärendem Namen, so daß sie Ihnen für spätere Projekte weiter zur Verfügung steht. Wenn Sie möchten, können Sie mir Ihre neue Konfigurations- datei auch zusenden, damit ich sie in zukünftige Versionen des extract Pakets aufnehmen kann. --------------------------------------------- 4.) Quellen weiterer Dokumentation --------------------------------------------- Die Abschnitte aus der AnyQuest for Windows on-line-Hilfe, welche sich mit Datenexport zu Zielsoftware von dritter Seite befassen, gelten weitgehend auch für die Programme extract und extract2. Die folgenden Dateien befinden sich derzeit im Verzeichnis \jmshome\qlr\document\manuals\ auf der LQ-Recorder Informations-CD oder im Abschnitt "Multimedia-Dokumente, Tutorials, ..." der WWW-Site: win\howto-anq2sas.html beschreibt, wie man Daten aus *.anq Dateien, die mit AnyQuest for Windows' eingebauter Export-Funktion erzeugt wurden, in die SAS Statistical Analysis Software einliest. Die alternative Verwendung des Programs extract wird ebenfalls erläutert. dos\lifequa5.pdf ist die deutsche Originaldokumentation des Lebensqualitäts-Recorders mit AnyQuest for DOS. Es behandelt die ursprüngliche Version des Programms extract und zeigt ein Beispiel für eine damit erzeugte Ausgabedatei. Die mitgelieferten Beispiele für Konfigurationsdateien enthalten Erkklärungen aller konfigurierbaren Optionen, zeigen, wie man diese einstellt, und weisen auch auf erweiterte Funktionalität der kürzlich erzeugten Versionen von extract und extract2 hin. Falls Sie außer den genannten Quellen weitere Informationen benötigen, können Sie mich auch selbst via e-mail oder telefonisch kontaktieren; weiterhin ander Anwender des Lebensqualitätsrecorders oder das Personal, das bei Ihnen für die Betreung der EDV/IT zuständig ist. --------------------------------------------- 5.) Alternativen zu extract / extract2 --------------------------------------------- extract / extract2 und die Datenexportfunktion, die in AnyQuest for Windows eingebaut ist, übertragen Daten aus mehreren einzelnen *.anq Dateien in eine Ausgabedatei in einem Tabellenformat. Typischerweise enthält eine solche Ausgedatei danach Daten aus mehreren Befragungen. Wenn Sie stattdessen die Ergebnisse einer einzelnen Befragung sofort verarbeiten und an eine dritte Software übertragen möchten (z.B. an eine SQL-Datenbank oder in eine Praxismanagementsoftware), so können Sie eine in AnyQuest für Windows eingebaute Funktion verwenden, über die externe Software aufgerufen werden kann. Darüber ist es möglich, entweder sofort nachdem eine *.anq Datei geschrieben wurde, oder jederzeit während der Befragung aus einer UPN Formel heraus eine externe Weiterverarbeitung von verfügbaren Daten auszulösen. Anwendungsbeispiele hierfür sind in der Software-Bibliothek derzeit wie folgt verfügbar: - Nahtlose bi-direktionale Integration von AnyQuest for Windows in Deutsche Praxismanagementsoftware über die standardisierte GDT-Schnittstelle, implementiert über zwei kleine Module und Konfigurationsdateien - Sofortiger automatischer Transfer von Ergebnissen über FTP zu einem Server, gefolgt von der Umwandlung einer *.anq Datei in eine Datei mit SQL-Anweisungen, welche vom Client der Interbase Datenbank ausgeführt werden, implementiert über DOS/Windows Batch-Dateien und Perl-Skripte - Sofortige Nachverarbeitung einer *.anq Datei, um eine korrespondierende Datei *.txt mit ausgewähltem Inhalt in einem spezifischen Format zu erzeugen, implementiert über ein einfaches Programm (und ergänzt durch weitere Programme, um die Patienten-Identifikation zu Beginn der Befragung von der deutschen Krankenversichertenkarte einzulesen) (Ende dieser Datei - end of file)