This document describes the different configuration modes, installation directories etc. of the Daily Report 3 software.
Set-up procedure
The Daily Report 3 program is a Microsoft .Net based application and can be used on Windows XP and later. The software is distributed by means of an installer package including all required libraries, form templates and customized configuration files.
Daily Report 3.3 is based on the .Net 4.0 runtime environment.
The set-up can be executed by users with administration rights. The set-up procedure consists of the following steps:
- Step 1: Unpacking the wrapper installer
- Step 2: Running the secondary installer
- Step 3: Executing the configuration procedure
Unpacking the wrapper installer
The software package consists of a standard file set including the executable, the library files (*.dll) and a set of customized configuration and data files. The wrapper installer files is typically named like customer-DAILY_REPORT_3-3.xxx.exe.
To ensure that the package can be transported as one file, the standard files are packaged into a secondary installer. After starting the set-up executable, the secondary installer and the configuration and data files are unpacked in a temporary folder. Then, the secondary installer program is started which does the real installation.
The particular files are described below.
Running the secondary installer
The secondary installer is typically named DailyReport3_Setup_3.xxx.exe. It is executed after the user confirms that he has no pending E-NOA/D generated with the currently installed version. After the license agreement, the user selects the installation directory where the program should be installed. Normally, this is the folder Daily Report below the root directory (c:\).
As long as the program is not run in network configuration mode (see below), the program doesn't require write access for the program folder. However, for network configuration, an appropriate program folder has to be chosen.Then, the installer unpacks the executable and the libraries along with the standard data files into the program directory. You can check out the installation activities by clicking on the Details button in the installer window.
The installer creates an import directory in the program directory and copies all form templates (*.ffv, * ffz) that were contained in the wrapper installer an are now located in the same directory as the secondary installer.
Silent installation
You can run the inner installer silently by using the following commands:
DailyReportV3_Setup_WithoutManuals_x86_3.24.01.exe /S /D=C:\DailyReport
where
/S = Silent mode
/D = the installation directory
In silent mode, no additional input has to be provided during the installation phase.
Executing the configuration procedure
When the user installed a new Daily Report version or updated an existing installation, the program will run the configuration procedure at the next start-up. To trigger the program configuration procedure, the secondary installer updates the installation time stamp in the dailyreport_v3.ini (see below). At start-up, the Daily Report program reads the INI file and compares the time stamp with the one stored in the file fssettings.xml. If the time stamps differ, the configuration procedure is executed.
Identification of the vessel
The first step is the identification of the vessel ID. This is normally the IMO number. If the wrapper installer contained a customized ship list (shiplist.csv), then the user can pick the vessel's name from the drop down control.
Otherwise, the user has to enter the vessel's name and the IMO number in the configuration dialog:
Copying files
After setting the vessel's ID, the program copies the files into the working directories (see below). The working directories depend on the configuration mode (standalone, network, shared) as defined in the INI file. The program creates a second import directory under the Fleetform working directory and copies the template files from the original import directory. The reason for the two-step import procedure is the missing write access rights during execution of the Daily Report program.
The program checks the second import directory for new files whenever it is started. New templates are moved and unpacked into the Fleetform working directory according to the operation area they are assigned to.
Then, the normal start-up procedure of the program is continued. The program reads the configuration files and the port list from the Daily Report working directory and then shows the login dialog.
Directories and Files
Depending on the different configuration modes, the data files are stored under the following working directories.
- Daily Report working directory: This directory contains different XML files like port lists, the current schedules and the agent details.
- Fleetform working directory: The folder contains the forms templates and form instances and some configuration files.
| Mode | Daily Report working dir | Fleetform working dir |
|---|---|---|
| Standalone | %PROGRAMDATA%\Herberg Engineering GmbH\Daily Report | %PROGRAMDATA%\Herberg Engineering GmbH\Fleetform
|
| Network | [Daily Report installation directory]\ | [Daily Report installation directory]\Fleetform
|
The Daily Report program directory
This directory is chosen when the user installs the program. The secondary installer unpacks the files into this directory.
- Directory import: This folder is used by the secondary installer to store form template files (*.ffv, *.ffz) during the installation process. when running the configuration procedure, the Daily Report program copies the files into the import directory under the Fleetform working directory.
| File name | Description
|
|---|---|
| *.xml | There are some XML files containing destinations that are copied by the program into the Daily Report working directory.
|
| *.dll | The libraries required by the software.
|
| dailyreport_v3.exe | The program executable.
|
| dailyreport_v3.ini | The INI file controlling the initial set-up.
|
| *.xsd | These files are required to validation against the official E-NOA/D data format.
|
| dailyreport3Manual_1_3.pdf | The program user manual.
|
| Fleetform Enoad Manual 1.0.5.pdf | The E-NOA/D manual.
|
| shiplist.csv | The customized ship list. Note that this list is optional. It it read during the configuration procedure.
|
| uninst.exe | The de-installation program. |
The Daily Report working directory
The following files are stored in the working directory:
| File name | Description | Origin
|
|---|---|---|
| agentList.xml | This is the data file containing all agent information the user has entered aboard.
Note that this file could also be provided from ashore if needed. |
Program/ashore
|
| canalList.xml | The list of canals the user may use for schedules. | ashore
|
| countryList.xml | The list of countries and states. | ashore
|
| dailyreport_v3.exe.config | This file contains some local settings like the last window size and position. In addition, the shared directory path is stored here. | Program
|
| fssettings.xml | This file contains the settings related to the Daily Report schedule module. | Program
|
| mergedDestList.xml | The program compiles this file merging the files portList.xml, rangeList.xml and canalList.xml. So, this files contains all available destinations. | Program
|
| portList.xml | The list of ports the user may select. | ashore
|
| positionreport.xml | The program saves here the last entries the user made when he sends a schedule report ashore. | Program
|
| rangeList.xml | This file contains the ranges the user may select as destinations. | ashore
|
| scheduleList.xml | The program stores the current and old schedules in this file. | Program
|
| shipdetails.xml | This file is used to store the ship details status only. | Program |
The Fleetform working directory
This folder contains all forms/report files. It has the following directories:
- Directory images: This folder contains images used by the form templates.
- Directory import: The program checks this directory at start-up for new form templates. The files are imported into the oa directory and then removed from that directory.
- Directory oa (stands for 'operational area'): This is the root directory for all Fleetform forms and templates.
| File name | Description | Origin
|
|---|---|---|
| config.xml | The configuration file for the form engine (Fleetform). This file contains the user settings the user has made on the system. | Program
|
| currentApmlListViewItems.xml | This file is created by the program to maintain a short-cut list of currently available form instances and there status.
This file may be deleted to let the program re-scan the entire oa directory. |
Program
|
| keyfile.xml | Key file for registration. | Program |
The configuration file dailyreport_v3.ini
The following listing shows an example for a configuration file:
| Section | Parameter | Description
|
|---|---|---|
| setup | savedir=c:\positions | This is the place where we store outgoing files. If not set, the user's desktop folder is used.
|
| setup | email=hpr@fleettracker.de | This is the destination email address of the Fleettracker server.
|
| setup | showScheduleTabs=1 | Set this to 0 to hide the schedule tab(s)
|
| setup | showFleetformTabs=1 | Set this to 0 to hide the fleetform tab(s)
|
| setup | enableEnoadWithoutReg=1 | Set this to 1 if you want to enable E-NOAD in any case
|
| setup | sharedDataDir= | Set this to a data directory if you want to use the program on different PCs in a network. If this is set, then interface/networkinst is ignored.
|
| interface | networkinst=1 | Set this to 1 if you want to save data and program files in the same directory path
|
| interface | disableAgent=0 | Set the to 1 if you do not require agent information
|
| interface | disableReports=0 | If 1, the user dows not need to fill out reports at arrival or departure.
|
| interface | show_posreport=1 | If 1, the user has to enter the position before sending the schedule.
|
| interface | may_skip_posreport=0 | If 1, the user may enter the current position but can also skip it. (effect only if show_posreport = 1)
|
| interface | disableAddNewHarbour=1 | Do not allow the user to add/remove ports
|
| interface | send_method=SEND_MAIL | Enter one of SAVE_TO_HARDDISK, SAVE_TO_FLOPPY or SEND_MAIL
|
| interface | enableCrewList=1 | Enable the crew list management
|
| interface | scheduleDisableAnchorageOption=1 | Do not allow the user to add anchorage as destination
|
| interface | scheduleDisableRangeOption=1 | Do not allow the user to add range as destination
|
| interface | scheduleDisableDriftingOption=1 | Do not allow the user to add drifting as destination
|
| interface | scheduleMandatoryETB=1 | Make ETB entry mandatory for a port
|
| interface | installed=2013-3-19T12:39:13 | The installation date written by the secondary installer. If this time stamp is different from the one contained in fssettings.xml, then the configuration procedure is executed. Otherwise, the configuration procedure is skipped. |
Configuration modes
The mode is set in the INI file by means of the variables networkinst (section interface) and sharedDataDir (section setup):
| Mode | networkinst | sharedDataDir | Remarks
|
|---|---|---|---|
| Standalone | 0 | empty | sharedDataDir has to be empty!
|
| Network | 1 | empty | sharedDataDir has to be empty!
|
The sharedDataDir variable has to contain the entire path to the Daily Report directory. If the path is not accessible or does not exist, the user is asked to select a valid path instead. The path is stored in the dailyreport_v3.exe.config file.