Appendix B - Flight Transaction Fields #

Introduction #

This appendix describes:

in the Glider Flight and Power Flight transactions.

Each field is listed separately, annotated with its type as described in Appendix A - Data Types.


Glider Flight Intrinsic Fields #

These fields are stored in glider flight transactions.

These fields all appear in all glider flight transactions.

logsheet-page #

Integer. The original paper logsheet page of the flight.

logsheet-line #

Integer. The line within the original paper logsheet page of the flight.

member-number #

String * 4 (MAX_ACCOUNT_NUMBER_LEN, in TRANFILE.BAS). The account number of the member paying for the flight.

trial-lesson-sale-month #

Integer. The month within which the trial lesson was sold, if the member-number field applies to a trial lesson account. January 1990 is month zero, February 1991 is month 13, etc.

trial-lesson-sale-day #

Integer. The day in month on which the trial lesson was sold, if the member-number field applies to a trial lesson account. The first day of the month is day one.

glider-number #

String * 4 (MAX_GLIDER_NUMBER_LEN, in TRANFILE.BAS). The number of the glider in which the flight was made.

tug-registration #

String * 2 (MAX_POWER_REGISTRATION_LEN, in TRANFILE.BAS). The abbreviated registration of the tug for the flight.

take-off-time #

Time. The logged time of take-off for the flight.

landing-time #

Time. The logged time of landing for the glider.

aerotow-height #

Integer. The entered height of the aerotow. This is always a multiple of 100 feet.

P1-number #

String * 4 (MAX_ACCOUNT_NUMBER_LEN, in TRANFILE.BAS). The account number of the P1/non-paying pilot for a flight. Blank if there is none.

ab-initio-circuit #

Integer. Whether or not the flight is an ab-initio circuit practice. One if it is, zero otherwise.

This field was used for a while and is kept for backward compatibility (so old transaction files can be processed) but its function has now been taken over by the special-rule-code. It cannot be set on newly posted glider flight transactions.

special-rule-code #

Special Rule Code. Symbol used to pass information to the charging rules on any special processing required for the transaction.


Power Flight Intrinsic Fields #

These fields are stored in power flight transactions.

These fields appear in all power flight transactions.

logsheet-page #

Integer. The original paper logsheet page of the flight.

logsheet-line #

Integer. The line within the original paper logsheet page of the flight.

member-number #

String * 4 (MAX_ACCOUNT_NUMBER_LEN, in TRANFILE.BAS). The account number of the member paying for the flight.

trial-lesson-sale-month #

Integer. The month within which the trial lesson was sold, if the member-number field applies to a trial lesson account. January 1990 is month zero, February 1991 is month 13, etc.

trial-lesson-sale-day #

Integer. The day in month on which the trial lesson was sold, if the member-number field applies to a trial lesson account. The first day of the month is day one.

P1-number #

String * 4 (MAX_ACCOUNT_NUMBER_LEN, in TRANFILE.BAS). The account number of the P1/non-paying pilot for a flight. Blank if there is none.

aircraft-registration #

String * 2 (MAX_POWER_REGISTRATION_LEN, in TRANFILE.BAS). The abbreviated registration of the aircraft.

chocks-start #

Time. The time of day of off chocks, if this is input for this aircraft. Zero if not input. Chocks times have never been used so this field is always zero. There is code to check that the chocks times fields are zero and much, but not all, of the code to process them has been removed. The fields are kept for compatibility with old transaction files and could, with some care, be renamed for other purposes in future.

chocks-time #

Time. The duration from chocks off to chocks on for the flight, if this is input for this aircraft. Zero if not input. Not used, see chocks-start.

flight-start #

Time. The time of day of take-off, if this is input for this aircraft. Zero if not input.

flight-time #

Time. The duration from take-off to landing for the flight, if this is input for this aircraft. Zero if not input.

tacho-start #

Time. The tacho meter reading at the start of the flight, if this is input for this aircraft. Zero if not input.

tacho-time #

Time. The flight duration as shown by the tacho meter for the flight, if this is input for this aircraft. Zero if not input.

hobbs-start #

Time. The hobbs meter reading at the start of the flight, if this is input for this aircraft. Zero if not input.

hobbs-time #

Time. The flight duration as shown by the hobbs meter for the flight, if this is input for this aircraft. Zero if not input.

retrieve-miles #

Integer. For aerotow retrieves, the one way distance to the field in nautical miles. Zero if not input.

These fields were introduced after the initial version of Max2 and so may not appear in all power flight transactions:-

flight-count #

Integer. The number of take-offs and landings in the flight. Used for the number of circuits carried out during off-tow training and to indicate whether an aerotow retrieve involved one flight (i.e., tug went to the field from tow) or two flights (i.e., tug made a special take-off for the retrieve). Could conceivably be zero for one charge for a dual aerotow retrieve.

fixed-price #

The price to be charged for the flight if it is different from that which would normally be charged according to the standard rules. Typically used if a price has been negotiated for some reason. £-0.01 (minus one penny) if present but not set (field left blank).


Intrinsic Rule Fields #

These fields are computed by the intrinsic rules. They apply to both glider and power flight transactions.

day-of-month #

Integer. The day in the month during which the flight took place (1 to 31).

day-of-week #

Integer. The day in the week on which the flight took place. Sunday is day one and Saturday is day seven.

weekend #

Integer. Whether or not the day was a non-week day. Zero means a weekday and one means it was a Saturday, Sunday or bank holiday.

membership-class #

Integer. The membership class of the member paying for the flight:

If the account does not exist then this field is undefined.

money-balance #

Currency. The account balance of the account referenced by the member-number field. Undefined if the account does not exist or if it is a trial lesson account.

aerotow-balance #

Currency. The number of feet of aerotow credit of the account referenced by the member-number field. Undefined if the account does not exist or if it is a trial lesson account.

TL-group-fixed-price #

Currency. Only set if for proper accounts for which the TL Group Fixed Price field is set.


Glider Flight Computed Fields #

The following fields should be computed by the glider flight charging rules. The rules can compute other fields for their internal use - these are the fields which Max2 itself will use.

Fields marked "required" must be created by the rule set. If they are not then an error is reported. Fields marked "optional" will be used by Max if the rule set creates them.

glider-type #

String. Required. The type of the glider (e.g, "K13"), displayed on the Glider Flight Entry window. If this field is set to "Private" then the glider is not listed separately in the transaction summary report.

glider-soaring-rate #

Currency. Required (Booker), Optional (BGGC). The hourly rate for the glider, displayed on the Glider Flight Entry window.

charged-take-off #

Time. Required. The time from which charging for the flight was started, displayed on the Glider Flight Entry window. This might be later than the actual take-off time because of rules such as free soaring before 10AM.

actual-flight-time #

Time. Required. The actual duration of the flight, displayed on the Glider Flight Entry window and used in reports.

charged-landing #

Time. Required. The time at which charging for the flight terminated, displayed on the Glider Flight Entry window. This may be before the actual landing time because of rules such as free soaring in single seaters after 6PM.

fixed-price #

Currency. Optional. Fixed price applied to a flight, typically for trial lesson groups.

aerotow-debit #

Integer. Optional. Amount by which the paying member's aerotow credit is to be reduced. Displayed on the Glider Flight Entry window and used when the transaction is applied to a member's account.

charged-flight-time #

Time. Required. The duration of the flight which was charged, displayed on the Glider Flight Entry window and used in reports. This may be less than the difference between the charged-take-off and the charged-landing because of rules such as free soaring after 2 hours.

soaring-fee #

Currency. Required. Amount charged for the flight time in the glider. Displayed on the Glider Flight Entry window and used in reports.

aerotow-fee #

Currency. Required (Booker), Optional (BGGC). Amount charged for the aerotow. Displayed on the Glider Flight Entry window and used in reports.

total-fee #

Currency. Required (Booker), Optional (BGGC). The total amount charged for the flight. Displayed on the Glider Flight Entry window and used when the transaction is applied to the member's account and in reports.

heading #

Heading. Required (Booker), Optional (BGGC). The heading the flight is to be included under in the club accounts. Displayed on the Glider Flight Entry window and used in the creation of transaction summary reports.

error #

String. Optional. A field which can be set to an error message string by the charging rules to indicate a problem detected with the transaction on input. The transaction will not be posted if this field is set.


Power Flight Computed Fields #

The following fields should be computed by the power flight charging rules. The rules can compute other fields for their internal use - these are the fields which Max2 itself will use.

Fields marked "required" must be created by the rule set. If they are not then an error is reported. Fields marked "optional" will be used by Max if the rule set creates them.

aircraft-type #

String. Required. Displayed on the Power Flight Entry window.

aerotow-debit #

Integer. Optional. Amount by which the paying member's aerotow credit is to be reduced. Used when the transaction is applied to a member's account. Typically used when an flight in a motor glider is charged against a course.

chocks-input #

flight-input #

tacho-input #

hobbs-input #

Integer. Optional. These four fields determine the types of time which need to be input for the aircraft. They control which time input fields are enabled on the Power Flight Entry window and are also used when formatting a power flight transaction to control which times are displayed.

If one of these fields is left undefined by the charging rules then the corresponding time input is disabled. If the field is defined then it should have one of the following values:

Chocks times are not used, see chocks-start.

retrieve-input #

Integer. Optional. If this field is set to the integer value 1 then the aircraft can do aerotow retrieves. The appropriate fields in the Power Flight Entry form are enabled.

If this field is not defined or set to any value other than 1 then the fields are disabled.

chocks-charged-time #

flight-charged-time #

tacho-charged-time #

hobbs-charged-time #

Time. Optional. The amount of time being charged for of each type. Displayed on the Power Flight Entry form.

Chocks times are not used, see chocks-start.

chocks-rate #

flight-rate #

tacho-rate #

hobbs-rate #

Currency. Optional. The hourly rate for each type of time. Displayed on the Power Flight Entry form.

Chocks times are not used, see chocks-start.

chocks-charge #

flight-charge #

tacho-charge #

hobbs-charge #

Currency. Optional. The amount charged for each type of time. Displayed on the Power Flight Entry form and used in reports, including on account statements.

Chocks times are not used, see chocks-start.

retrieve-charge #

Currency. Optional. The amount charged for aerotow retrieves which are charged by the nautical mile. Displayed on the Power Flight Entry form.

total-fee #

Currency. Required. The total amount charged for the flight. Displayed on the Power Flight Entry window and used when the transaction is applied to the member's account and in reports.

heading #

Heading. Required. The heading the flight is to be included under in the club accounts. Displayed on the Power Flight Entry window and used in the creation of transaction summary reports.

error #

String. Optional. A field which can be set to an error message string by the charging rules to indicate a problem detected with the transaction on input. The transaction will not be posted if this field is set.