Appendix A: Field definitions
Layout tab
When you create a new custom layout, you must select the type of layout you want to create. Select from the following types when you click the New drop-down to add a new layout:
Production chit provides the elements you need to design a custom chit to print in the kitchen, such as an expo chit, kitchen chit, and tray chit. You must include the Items and Training elements on a custom chit of this type to save the new layout.
Guest check provides the elements you need to design a custom guest check. You must include the Items and Training elements on a custom guest check to save the new layout.
General message provides the elements required to design a printed voucher for use with campaigns.
Order taker provides the same elements you need to design a custom chit to print in the kitchen (production chit) without the requirement of including the Items and Training elements. With this type, if you include one of the available elements in your design, you can save and use the new layout.
Name — Identifies the layout.
Design tab
Use the Design tab to choose the elements to include in the custom layout you are designing and to change how elements appear in the layout, such as font, alignment, and more.
Group bar: Design
Element — Indicates the elements already selected to include in the custom layout. To add an element, click the Add drop-down arrow to display the Type list box and select from the list of available elements for the specific type of layout you are designing. For example, if you select ‘Guest check’ as the type of layout, only the elements available to add to a custom guest check layout appear in the Type list box.
Group bar: Design id="print-style-settings"> Print style settings
Size — Specifies the relative size of the printed text. Select from Large, Medium, Small, Very small, and Very large.
Alignment — Specifies the horizontal position of the element on the layout. Select from Left, Center, and Right.
Expanded width — Stretches the printed element horizontally across the line.
Expanded height — Increases the height of the printed element.
Red — Prints the element in red.
Suppress leading line feed — Does not precede the element with a leading blank line, if any. For example, when you add the ‘Alerts’ element, a blank line usually precedes the element on the printed artifact. When you select this option, the system does not precede the Alerts element with a blank line, which promotes a ‘green’ environment.
Suppress trailing line feed — Does not follow the element with a trailing blank line, if any. For example, when you add the ‘Ordermode name’ element, a blank line usually follows the element on the printed artifact. When you select this option, the system does not follow the ‘Ordermode name’ element with a blank line, which promotes a ‘green’ environment.
Group bar: Design id="line-attribute-overrides"> Line attribute overrides
Allows you to add color, italic, underline, and bold to an element. Required Options: You must select ‘Production chit’ as the layout type to expose this group bar.
Use line attribute overrides — Enables you to use additional basic text attributes, such as bold, italic, and underlined, and to print the element in a color of your choice. This allows an element to stand out while other elements print normally. Selecting this option exposes the remaining options in the group bar. Required Options: You must select ‘Production chit’ as the layout type to expose this option.
Color — Specifies the color in which to print the text of the element. The default is 0.0.0. You must use a color printer. Required Options: You must select ‘Production chit’ as the layout type to expose this option.
Italic — Prints the text of the element in italic. Required Options: You must select ‘Production chit’ as the layout type to expose this option.
Underlined — Prints the text of the element with an underline. Required Options: You must select ‘Production chit’ as the layout type to expose this option.
Bold — Prints the text of the element in bold. Required Options: You must select ‘Production chit’ as the layout type to expose this option.
Group bar: Design id="bag-label-settings"> Bag label settings
Prints the current name, and the total number of bags, on the order label. Required Options: You must add the Bag label sequence element to expose this group bar.
Bag label text — Specifies the text to print on the left of a custom line. Required Options: You must add the Bag label sequence element to a layout to expose this option.
Group bar: Design id="custom-line-settings"> Custom line settings
Allows you combine up to three elements from a limited list on one line. Required Options: You must add the Custom line or Custom line for label printing element to expose this group bar.
Left — Specifies the element to print on the left of a custom line. Select None to show the area as blank. Required Options: You must add the Custom line or Custom line for label printing element to expose this option.
Center — Specifies the element to print in the center of a custom line. Select None to show the areasas blank. Required Options: You must add the Custom line or Custom line for label printing element to expose this option.
Right — Specifies the element to print on the right of a custom line. Select None to show the area as blank. Required Options: You must add the Custom line or Custom line for label printing element to expose this option.
Group bar: Design id="custom-paid-line-settings"> Custom paid line settings
Allows you to define the text to appear on the chit when a check is tendered, such as ‘PAID OUT.’ Required Options: You must add the Custom paid line text element to a layout to expose this group bar.
Text — Specifies the text to use for the paid line. Required Options: You must add the Custom paid line text element to a layout to expose this option.
Group bar: Design id="filled-line-settings"> Filled line settings
Allows you to print a line using the character you designate, such as *. Required Options: You must add the Filled line element to a layout to expose this group bar.
Text — Specifies the character to print across the line. Required Options: You must add the Filled line element to a layout to expose this option.
Group bar: Design id="image-settings"> Image settings
Allows you to add an image to the layout. Required Options: You must select the ‘Image’ element to expose this group bar.
Select image — Specifies the image to add. Required Options: You must add the Image element to a layout to expose this option. Related Requirement: You must upload the image using the Media Files function.
Group bar: Design id="label-print-sequence-settings"> Label Print Sequence settings
Allows you to print the ‘x of y’ label sequence on the production chit. Required Options: You must add the Label print sequence element to a ‘Production chit’ or “Order taker chit’ layout to expose this group bar.
Label print text — Specifies the text to print for an ‘x of y’ printing sequence on the kitchen chit. The default is ‘Label print is {0} of {1},’ enclosed in braces, where {0} is the specific print number and {1} is the total number of prints. You can modify the free text to further customize the text that prints on the chit. Required Options: You must add the Label print sequence element to a ‘Production chit’ or “Order taker chit’ layout to expose this option. Documented Version: v19.11.
Group bar: Design id="loyalty-customer-name-and-image-settings"> Loyalty customer name and image settings
Allows you to add the Loyalty name and image to a production layout. Required Options: You must add the Loyalty customer name and image element to expose this group bar.
Loyalty image — Specifies the image to add. Required Options: You must add the Loyalty customer name and image element to expose this option. Required Requirement: You must upload the image using the Media Files function.
Group bar: Design id="placeholder-text-settings"> Placeholder text settings
Allows you to add free text to the layout. Required Options: You must add the Placeholder Element or Placeholder Text element to a layout to expose this group bar.
Placeholder text settings
Allows you to define free-form, non-printing text to include in the layout. This text serves as a label in the list of elements on a chit, such as END OF HEADER or START OF TRAILER. Required Options: You must add the Placeholder Element or Placeholder Text element to a layout to expose this option.
Group bar: Design id="redemption-period"> Redemption period
Establishes the number of calendar days after printing a reward voucher an offer is valid. The system uses the number of days to determine and print the beginning and ending dates during which a guest can redeem a voucher for an earned reward. Required Options: You must add the Redemption Period element to expose this group bar.
Redemption period (in days)
Specifies the number of days to allow the consumer to redeem a voucher for an earned reward. Default Alignment: Centered. Required Options: You must add the Redemption Period element to expose this option.
Reference: Refer to the Campaign Rulebook Feature Focus Guide - HKS324 for more information.
Group bar: Design id="user-text-settings"> User text settings
Allows you add free text to the layout. Required Options: You must add the User text element to a layout to expose this group bar.
User text settings — Allows you to define free form text to include in the layout. Required Options: You must add the User text element to a layout to expose this option.