Aspect Software

 

Back-office software for Restaurateurs

 
 
 

Processed HSI Journal File Format

 

(Revised 04-25-2000)


 

This document describes the contents of the processed HSI journal file. The information contained in this document can be used to extend the Aspect sales record or as an aid in importing the processed journal file to another application such as a database application running at a central office.


 

Before sales data can be imported into Aspect, the HSI journal file must be copied into the Aspect store directory. The file is a binary file named journal.dat. When Aspect imports the journal, the original file is renamed to journal.~at, the file is processed, and a new journal.dat is created. The new journal.dat file is a summary of the raw data contained in the original binary file. The processed file is imported into Aspect and can also be viewed in any text editor, loaded into a spreadsheet or imported into another application.


 

The table below describes the contents of the processed journal file. Note that line numbers begin at zero, not one. Column numbers begin with one. This is the way that fields are defined in the Aspect sales record. For example, to import Discounts for department 10, the field would be *9,8. This is because line 9 contains data for department 10 and the discount figure is in column 8. (In Aspect, an * indicates that a line number follows. The syntax for a field description is *line number,column number).


 

Also note that two sets of totals are provided for departments, categories, comps, discounts and voids. For example, department totals appear on lines 0 – 9 and lines 228 – 247. This is because earlier versions of the HSI system provided for a limited number of each type of data. When the HSI system was revised to extend the number of each type of data, additional data was appended to the processed journal file. The original layout of the processed journal was preserved in Aspect to maintain backwards compatibility.


 

It does not matter which set of totals you choose to import from as long as you find the data that you need. For example, totals for department 1 may be imported from line 0 or line 228. However, totals for department 11 would need to be imported from the second set of totals since the first set of data only contains totals for ten departments.


 

If it becomes necessary to extend the processed journal again, new data will be appended as before. You can be sure that the layout provided below will remain constant.


 

Department Totals (10 lines, one for each department)

Line #

Record ID

Column

Description

0 – 9

0

1

Record identifier – 0

2

Department number

3

Gross Sales (Including voids, comps and discounts, but not including tax)

4

Voids

5

Actual Sales (Gross Sales – Voids)

6

Comps

7

Adjusted Sales (Actual Sales – Comps)

8

Discounts

9

Net Sales (Adjusted Sales – Discounts)

10

Tax 1

11

Tax 2

Category Totals (72 lines, one for each category)

Line #

Record ID

Column

Description

10 – 81

1

1

Record identifier – 1

2

Category number

3

Gross Sales (Including voids, comps and discounts, but not including tax)

4

Voids

5

Actual Sales (Gross Sales – Voids)

6

Comps

7

Adjusted Sales (Actual Sales – Comps)

8

Discounts

9

Net Sales (Adjusted Sales – Discounts)

10

Tax 1

11

Tax 2

Comps (10 lines, one for each type of comp)

Line #

Record ID

Column

Description

82 – 91

2

1

Record identifier – 2

2

Comp ID – (corresponds to ID numbers in comp.tbl)

3

Count (number of this type of comp)

4

Amount (total dollar amount for this type of comp)

Gift Certificates Sold (10 lines, one for each type of gift certificate)

Line #

Record ID

Column

Description

92 – 101

3

1

Record identifier – 3

2

Gift Certificate ID – (corresponds to ID numbers in giftcert.tbl)

3

Count (number of this type of gift certificate)

4

Amount (total dollar amount for this type of gift certificate)

Tenders (30 lines, one for each type of tender)

Line #

Record ID

Column

Description

102 – 131

4

1

Record identifier – 4

2

Tender ID – (corresponds to ID numbers in pymt.dat)

3

Count (number of this type of tender)

4

Amount (total dollar amount for this type of tender)

5

Tips

6

Change Given

7

Auto-gratuity

Voids (10 lines, one for each type of void)

Line #

Record ID

Column

Description

132 – 141

5

1

Record identifier – 5

2

Void ID – (corresponds to ID numbers in void.tbl)

3

Count (number of this type of void)

4

Amount (total dollar amount for this type of void)

Discounts (10 lines, one for each type of discount)

Line #

Record ID

Column

Description

142 – 151

6

1

Record identifier – 6

2

Discount ID – (corresponds to ID numbers in disc.dat)

3

Count (number of this type of discount)

4

Amount (total dollar amount for this type of discount)

Miscellaneous Totals (16 lines containing miscellaneous totals)

Line #

Record ID

Column

Description

152-167

N/A

1

Taxable Sales 1

1

Taxable Sales 2

1

Non-Taxable Sales 1

1

Non-Taxable Sales 2

1

Tax Collected 1

1

Tax Collected 2

1

On Account Payment

1

Gift Certificate Sales

1

Total Paid-Outs

2 – 31

Amount for each type of paid-out (1 – 30)

1

Total Paid-Ins

2 – 31

Amount for each type of paid-in (1 – 30)

1

Total Quick Sales

1

Total Table Sales

1

Total Tickets

1

Total Guests

2

Total Entrees

1

Number of Tables

1

Total table time dining time in minutes

Comps (30 lines, one for each type of comp)

Line #

Record ID

Column

Description

168 – 197

7

1

Record identifier – 7

2

Comp ID – (corresponds to ID numbers in comp.tbl)

3

Count (number of this type of comp)

4

Amount (total dollar amount for this type of comp)

Discounts (30 lines, one for each type of discount)

Line #

Record ID

Column

Description

198 – 227

8

1

Record identifier – 8

2

Discount ID – (corresponds to ID numbers in disc.dat)

3

Count (number of this type of discount)

4

Amount (total dollar amount for this type of discount)

Department Totals (20 lines, one for each category)

Line #

Record ID

Column

Description

228 – 247

9

1

Record identifier – 9

2

Department number

3

Gross Sales (Including voids, comps and discounts, but not including tax)

4

Voids

5

Actual Sales (Gross Sales – Voids)

6

Comps

7

Adjusted Sales (Actual Sales – Comps)

8

Discounts

9

Net Sales (Adjusted Sales – Discounts)

10

Tax 1

11

Tax 2

Category Totals (250 lines, one for each category)

Line #

Record ID

Column

Description

248 – 497

10

1

Record identifier – 10

2

Category number

3

Gross Sales (Including voids, comps and discounts, but not including tax)

4

Voids

5

Actual Sales (Gross Sales – Voids)

6

Comps

7

Adjusted Sales (Actual Sales – Comps)

8

Discounts

9

Net Sales (Adjusted Sales – Discounts)

10

Tax 1

11

Tax 2

Voids (30 lines, one for each type of void)

Line #

Record ID

Column

Description

498 – 527

11

1

Record identifier – 11

2

Void ID – (corresponds to ID numbers in void.tbl)

3

Count (number of this type of void)

4

Amount (total dollar amount for this type of void)

Hourly Sales By Department (20 lines, one line for each department)

Line #

Record ID

Column

Description

528 – 547

12

1

Record identifier – 12

2 – 25

Hourly sales beginning with 12:00am – 12:59am

Half-Hour Sales By Department (20 lines, one line for each department)

Line #

Record ID

Column

Description

548 – 567

13

1

Record identifier – 13

2 – 49

Half-hour sales beginning with 12:00am – 12:29am

Total Hourly Sales (1 line containing total hourly sales for all departments)

Line #

Record ID

Column

Description

568

14

1

Record identifier – 14

2 – 25

Total hourly sales beginning with 12:00am – 12:59am

Hourly Entrees By Department (20 lines, one line for each department)

Line #

Record ID

Column

Description

569 – 588

15

1

Record identifier – 15

2 – 25

Hourly entrees beginning with 12:00am – 12:59am

Total Hourly Entrees (1 line containing total hourly entrees for all departments)

Line #

Record ID

Column

Description

589

16

1

Record identifier – 16

2 – 25

Total hourly entrees beginning with 12:00am – 12:59am

Total Hourly Guest Count (1 line containing total hourly guest counts)

Line #

Record ID

Column

Description

590

17

1

Record identifier – 17

2 – 25

Total hourly guest count beginning with 12:00am – 12:59am

-->