Erstellen von Setup-CD und Upgrade Paketen

Aus Recorder-Wiki
Wechseln zu: Navigation, Suche

Dictionary Upgrade

Zusammenstellen des Upgrade Paketes

  • Letzte Version des Dictionary Upgrades kopieren.
  • Neue Skripte in den Ordner "Scripts" einfügen.
  • Darauf achten, dass keine Lücken in den Sequenzen entstehen.

Selbstextrahierendes Archiv erstellen

Erläutert wird die Erstellung mit WinRar. RAR-Archiv erstellen: alle Dateien und den Ordner "Scripts" markieren. Mit Befehle → Dateien zum Archiv hinzufügen zu einem RAR-Archiv hinzufügen. WinRAR erstellt den Dateinamen des Archivs aus dem des übergeordneten Ordners. Selbstextrahierendes Archiv erstellen: RAR-Archiv markieren. Extras → Archiv in SFX konvertieren auswählen. Im Dialogfenster unter dem Reiter SFX SFX Modul Default.SFX auswählen. Erweiterte SFX-Optionen öffnen. Im Dialogfenster folgende Auswahl/Einträge vornehmen:

  • Reiter Allgemein: keine Einträge
  • Reiter Setup:
Nach dem Entpacken ausführen: DictionaryUpgrade.exe
keine weiteren Einträge
  • Reiter Modi:
Im temporären Verzeichnis entpacken: ausgewählt
Alles anzeigen: ausgewählt;
Nichts weiter eintragen und auswählen.
  • Reiter Erweitert:
Administratorzugriff erfragen: aktiviert;
Nichts weiter eintragen und auswählen.
  • Reiter Update:
Dateien packen und ersetzen: ausgewählt;
Vor dem Überschreiben nachfragen: ausgewählt;
  • Reiter Text und Icon:
Titel des SFX-Fensters: Recorder Dictionary Upgrade
Im SFX-Fenster angezeigter Text: "Extrahiere Dateien für Recorder Dictionary Upgrade"
Lade SFX-Logo aus Datei: D:\Buero\Recorder\SetupPakete\Icons\DictionaryUpgrade.bmp   ►(durch eigenen Pfad ersetzen)
Lade SFX-Icon aus Datei:  D:\Buero\Recorder\SetupPakete\Icons\DictionaryUpgrade.ico     ►(durch eigenen Pfad ersetzen))
  • Reiter Lizenz:
Nichts eintragen und auswählen.

Mit [OK] bestätigen. Und im Erstellungsfenster erneut mit [OK] bestätigen.

Die EXE-Datei wird erstellt. Nach Fertigstellung diese per Doppelklick im Datei-Manager von WinRAR öffen und kontrollieren, ob alle Dateien enthalten sind. Danach live testen.


It is possible to modify the image of the Recorder installation CD to customise the data, addins and additional files that are available to the user immediately after installation. An example of the usage of this facility is in countries other than the UK which prepare versions of the installation CD containing localised maps, checklists and other data. For more information on the internationalisation of Recorder, please see Adopting Recorder in new countries.

In order to achieve this, first copy all files from the CD to a folder on a local disk. Once the required modifications to the CD image have been performed, a new CD can be cut from this local folder.

Customising the list of addins

On the installation CD, there is an Install Files\Addins folder. Any addin files that should be placed into the user's Addins folder are stored in this folder. Placing a file into this folder does not cause it to get registered ready for use in Recorder. To achieve this the addin's file name (*.dll or *.ocx) must be added to the contents of the DefaultAddins.txt file in the same folder.

A common requirement for changing the list of addins is to install new spatial reference systems for use against local maps for international versions of Recorder. There is now an addin available which can be configured in order to support the majority of worldwide spatial reference systems. Please contact Dorset Software for more information about this addin.

Customising the list of base maps

The Recorder installation CD default image contains base maps for an outline of Great Britain, United Kingdom or Ireland. It is possible to modify this list according to local needs, though the file format required is unique to the mapping system used within Recorder. It is possible to convert an ESRI Shape File (*.shp) or Map Info File (*.mif) using the following steps:

  1. Using the Map Options dialog in Recorder, add a new map to the Enabled Maps tab. The Base Map you use does not matter at this stage. Reset the map.
  2. Using Windows Explorer, browse to your Object Sheet directory in your Recorder install. Note the list of files that are present in the directory.
  3. Open the map you just created in the Map Window. Select Map\Add Boundary\Import from the Map menu. Select the *.shp or *.mif file and press Open on the dialog.
  4. Once Recorder has finished importing the file, close Recorder.
  5. Copy any new files that have been placed into the Object Sheet folder into your Base Maps folder. There should be 4 of them, with the file extensions *.mdx, *.gsf, *.gix and *.gdb. Rename each of these files to a file name that described your map, e.g. "My County Map", leaving the file extensions as they are. The files must all have the same file name but with a different file extension.
  6. Save a new text file into the Base Maps folder, with the same file name as the files in the previous step but with the extension .ini. Into this file, type the following text:


Replace the xxxx characters with the code used by Recorder to define the spatial reference system that your map uses (e.g. LTLN) and replace the yyyy characters to briefly describe the base map. There are some examples of existing files already present in the Base Maps folder. Finally, save the file.

  1. It's a good idea to test that you can open this base map now in Recorder by creating a new map.
  2. When you are happy that it works, copy the 5 map files from your Base Map folder into the Install Files\Base Maps folder on your CD image.

Customising the default installed database

One possibility available when customising the Recorder installation CD is to prepare a database containing different data to the standard CD. This approach allows the initial contents of the Taxon Dictionary, Biotope Dictionary and Admin Area Dictionary to be controlled. It is also possible to create a standard list of locations, people, references or termlist entries which then form part of the installation.

The simplest approach to this is to install a clean copy of Recorder then use the built in Recorder screens to alter the database as required. For example, enter a list of standard locations for your CD image. Do not enter any data which you do not want to appear on the system as part of the installation. Once you have entered the required data the next step is to update the CD image's copy of the database with the copy you have created. To achieve this you will need an application that lets you manage SQL Server, for example SQL Server Management Studio Express. The following instructions were compiled using SQL Server Management Studio but the steps should be broadly similar in other management tools.

  1. Before proceeding, it is a good idea to upgrade to the latest release of Recorder ensuring that all recent database upgrades are applied.
  2. Using SQL Server Management Studio, connect to the NBNData database used by Recorder using an account with database owner rights (e.g. the "sa" login).
  3. Open the Databases folder then find the NBNData database item in the tree view.
  4. Right click on the NBNData database item and select Tasks\Shrink\Database... from the context menu.
  5. Check the option to "Reorganise files before releasing unused space. Selecting this option may affect performance.". This option ensures that the size of the database file placed on the CD image is minimised.
  6. Before proceeding, ensure all Recorder users are disconnected from the system, then press the Ok button.
  7. Once the shrink operation is complete, you need to detach the database making it available as a file for inclusion on the installation CD image. Right click on the NBNData database item and select Tasks\Detach... from the context menu, then click Ok on the dialog.
  8. Now, locate the NBNData_Data.mdf file. For a default installation of MSDE this will be in C:\Program Files\Microsoft SQL Server\MSSQL\Data. If you are using a SQL Server then your database administrator will be able to advise you where the file is stored. Add this file into the file in the System\Database folder on your CD image, replacing the existing file which already exists in the zip file.
  9. Finally, you may like to re-attach the database file so that it is ready for the next time you need to update the CD image's installation database. To do this, right click the Databases folder node in SQL Server Management Studio and select Attach... Click the Add button and browse to locate the NBNData_Data.mdf file that you identified earlier. Before selecting the Ok button on the Attach Databases dialog, identify the Owner column from the grid at the top and ensure that the owner is set to "sa". Then click Ok to attach the database.

If the changes to the Recorder database involve changes to the Taxon Dictionary, then simple edits can be performed using the Edit Taxon Details screen in Recorder. Additional facilities for editing of taxon lists are available by installing the Dictionary Manager Addin, or by using the Collections Module Addin's Thesaurus Editor application. Changes to the Biotope Dictionary can be performed using the Recorder Edit Biotope Details screen. There are no standard tools for editing the Admin Areas Dictionary, though direct manipulation of the admin area records in the database is possible. For more information on these addins or techniques please contact Dorset Software.

Customising Termlists

If the changes to the Recorder database involve changes to one of the Termlist tables, then it is important to ensure that none of the terms required by the Recorder application for its operation are removed. Note that it is not possible to remove these terms using the Recorder application user interface, though they can be removed by editing the database directly. It is possible to rename the terms described by these records, but removing the records entirely may cause errors in the application. The following records should not be removed:

Table Primary Key Default Term
Determiner Role NBNSYS0000000003 Original Recorder
Determination Type NBNSYS0000000001 Invalid
Determination Type NBNSYS0000000004 Original
Location Feature Grading NBNSYS0000000001 None
Measurement Context NBNSYS0000000003 Taxon Occurrence
Measurement Unit NBNSYS0000000006 Metres
Measurement Unit NBNSYS0000000009 Count
Measurement Qualifier NBNSYS0000000003 None
Measurement Qualifier NBNSYS0000000004 None
Organisation Type NBNSYS0000000001 None
Record Type NBNSYS0000000001 None
Recorder Role NBNSYS0000000002 Recorder
Sample Type NBNSYS0000000001 Field Observation
Substrate NBNSYS0000000001 None
Survey Media NBNSYS0000000001 None
Survey Status NBNSYS0000000001 None
Taxon Name Type NBNSYS0000000000 Not Given

Customising the contents of the User Files folder

In a Recorder installation, the User Files folder is used to store saved files and other files specific to the user installation. The following files are saved within sub-folders of this folder and can be used to introduce or change the list of files available on installation:

  • Batch Updates - contains XML files that define batch updates available within Recorder.
  • Import Templates - contains XML files that define templates used for the Import Wizard, which define mappings between import columns and Recorder fields.
  • Recording Cards - contains record card templates defined for data entry.
  • Reports - contains Report Wizard saved files as well as XML Report definition files.
  • Rucksacks - contains saved rucksack (*.ruk) files.
  • Templates - contains saved layout templates for formatting report output.

For each of these folders, the recommended approach is to first use Recorder to create the files required for the installation. The exception to this is new XML Report files which must be developed outside Recorder. For more information on developing new XML reports, see Custom XML Report Writing Tutorial.

Once the files are available they can be added to the installation CD image. To add a file to the CD image, for standalone CDs open the System folder then open the file. Within this zip file, expand the User Files directory. The required sub-folder may or may not be present; if it is not present then create it. Finally, add the new files to be installed to this subfolder. For the network installation CD image, the new files to be installed can simply be copied to the Install Files\User Files directory, placing them in the appropriate sub-folder and creating the sub-folder if required.

Changing the default spatial reference system

On the CD image, there is a file called SpatialSystems.txt in the System folder. This contains a list of the spatial reference systems that are available for selection by the user during the installation process. The one listed first in the list is the default.

Each entry in the list contains a description of the spatial reference system followed by the code used by Recorder to identify the spatial reference system (e.g. LTLN, OSGB or OSNI), separated by an equals sign. When adding new systems to this list, ensure that the addin required to support the system is also included on the installation CD and is installed by default.

Adding new user interface languages

Language files for the main Recorder application allow the language of all visible controls, labels and messages to be changed. There are 2 files required for each language, one called RecorderApp.XXX and one called RecorderApp.XXX.lng, where XXX is the 2 or 3 character Windows code for the language (e.g. RecorderApp.DEU.lng). More information on creating these files is available on the page Adopting Recorder in new countries.

Translation is performed using a free tool called Language Manager. Please contact Recorder-D if you are interested in using this tool. Once the translation has been performed, the resulting language files need to be placed in the root folder of the file in the CD image System folder (for the Standalone Installation CD) or in the CD image Install Files folder (for the Network Installation CD).

Translating the Measurement_Context table

The Measurement_Context table defines the different parts of Recorder that are available for measurement types to be associated with. For example, it is possible to associate altitude measurements so that they are only available for locations and abundance measurements so they are only available for taxon occurrences. Please note that if you translate the contents of the Measurement_Context table into a different language, then you must also translate the following resource strings in the ReportGenerator unit to match for the sample and location rows. If this is not done, then the measurement columns will not be available in the Report Wizard attributes selection.

Resource String English term
ResStr_RptGenSample Sample
ResStr_RptGenLocation Location

In addition, it is necessary to translate the Item_Group attribute of the Report_Attribute table to match the translations, so that the measurements and the other associated attributes end up under the same folder.

Adapting zero abundance flag

The setting of the zero_abundance flag in the taxon_observation table is achieved in the internationalised version of Recorder via translation tables. You must translate the following resource strings in the GeneralData unit

  • GeneralData.ResStr_MTypeAbundance: "Abundance"
  • GeneralData.ResStr_MUnitCount: "Count"

to match for the short_name of

  • measurement_type_key = 'NBNSYS0000000004' in the measurement_type table
  • measurement_unit_key = 'NBNSYS0000000009' in the measurement_unit table

Customising the SQL Server installation link

Because SQL Server regularly releases new versions and there are various problems with installation of different versions with different operating system versions, the paragraph added to the first page of the install kit is configurable simply by editing the installSqlServer.html file in the root of the standalone install CD.