Guides
      Back to home
      1. Logic Controls Product Support
      2. Guides

      XML template and tag descriptions:

      The integration between POS software and KitchenGo software suite is simple and fast. All you need to do is generate an order file that uses XML file format then send it to KitchenGo through either share folder or TCP/IP. Please check XML order sample and its format below for detail.

      All Logic Controls KDS software communicates with POS by accepting an XML file via folder drop or TCP/IP. Some characters are generally reserved to indicate markup such that they cannot be used for character data. These characters are <, >, and &. Sometimes single and double quotes are also considered as reserved characters. To use those characters in the XML string please use the replacements as follow:

       • &lt; instead of <

      • &gt; instead of >

      • &amp; instead of &

      • &apos; instead of '

      • &quot; instead of "

      • &#37; instead of %

      Note: For node properties, you should NOT convert single or double quotes to &apos; or &quot;. For example, version="1.0", encoding="UTF-8", BG="10", FG="255"

      After creating the XML file, you may use Internet browser to open and see whether it complies with XML standard.

      Tag

      Description

      <Transaction> </Transaction>

      Start and End of XML file

      <Order> </Order>

      Start and End of the order content. All information needs to be included between these 2 tags.

      <ID>198</ID>
        • Order ID. Order ID must be unique in whole system. It can be string or integer.
        • Item ID. Each item must have a unique ID. It can be string or integer.
        • Condiment ID. Condiment ID must be unique within each item. It can be string or integer.

      <PosTerminal>2</PosTerminal>

      Information of the POS Terminal

      <TransType>n</TransType>

      Define which type the order or item is.

      For order, there are 5 different types in total:

          • When n=1: add new order.
          • When n=2: delete existing order. Only order ID tag needs to be included.
          • When n=3: modify existing order. Only modified tag(s) needs to be included.
          • When n=4: transfer order to other station. See transfer tag below.
          • When n=5: request order status.

      For item, there are 3 different types:

          • When n=1: add a new item.
          • When n=2: delete this item.
          • When n=3: modify this item.

      For condiment there are 3 different types total:

        • When n=1: add a new condiment.
        • When n=2: delete this condiment.
        • When n=3: modify this condiment.

      <OrderStatus>n</OrderStatus>

       

      Define order transaction status:

        • When n=0: order is unpaid
        • When n=1: order is paid
        • When n=2: order is in process

      <OrderType>string</OrderType>

      Define order priority:

        • When the string is empty, it is a standard order.
        • When string=RUSH, it is a RUSH order.
        • When string=FIRE, it is a Fire order.

      <ServerName></ServerName>*

      Waiter or waitress’ information

      <Destination>Dine in</Destination>

      Order destination:

      Can be used to sort orders by destination when using tab display feature.

      Will show up on Order Header if enabled under Order header display settings in KDS.

      Will show up on items if added between <Item><Item> tag.

      <GuestTable>S:01</GuestTable>

      Table name and/or number

      Will show up on Order Header if enabled under Order header display settings in KDS.

      <Seat>Seat 1</Seat>

      Information on Seat, whether it be the number, name of the customer etc...

      <UserInfo>userinfo</UserInfo>

      Information on UserPOSin can be used to display a message.

      Will show up on Order Header if enabled under Order header display settings in KDS.

      <HeaderFooterMessage></HeaderFooterMessage>

      Custom Message user can display on the header.

      Can be enabled in KDS header or footer settings.

      Ex.<HeaderFooterMessage>Contains Peanuts</HeaderFooterMessage>

      <Parked>no</Parked>

      A parked order will go to parked pool and won't be displayed on panels. Its value can be yes/no or 1/0

      <Parked UnparkAt=” “></Parked>

      Use Unix or ISO 8601 to have parked order unpark automatically at set time.

      Note: Please make sure time on device has been set to correct time zone and time.

      <IconIndex>n</IconIndex>

       

      Display icon on the order header.

      <OrderMessages></OrderMessages>*   

      Start and End of order message, everything inside these two tags is an order message

      <Count>n</Count>*

      Order message and/or Premodifier count of message 0<=n<=2

      <S0>Order Message 0</S0>*

      Message contents of message 0

      <S1>Order Message 1</S1>*

      Message contents of message 1

      Note: Needs to be used inside of

       Premodifier/OrderMessages tag to show on order.

      <CatDelay></CatDelay>

      The CatDelay tag is used to set a delay time for an item or group of items.

      Note: It is recommended to not use this tag in conjunction with the <PreparationTime> tag as currently, it will cause both features to not work properly.

      <Item></Item>*

      Start & End of item, everything inside these two tags is item content.

      <Item ItemType="1"></Item>*

      Start & End of Expo item, when POS send ItemType="1", this item is Expo item means this item will only show in Expo station (Good for items that only handle in Expo station)

      <BuildCard></BuildCard>*

      Use to display an image or recipe of an item using an image url.

      Supports: jpg, bmp, png, jpeg and gif files.

       

      Can be also used inside a Condiment.

      <TrainingVideo> </TrainingVideo>

      Used to display a video when an item is selected using an image url.

      Supports: mov, mkv, mp4, and avi files.

       

      Can be also used inside a Condiment.

      <PreparationTime></PreparationTime>

      Start & End of preparation Time, used for smart order on the fly timer, input type is double, unit in minutes. E.G.: 1.5

      <HideStation>1,3,4</HideStation>

       

      Hide item on these stations.

      <Customer>Joe</Customer>

      Start and end of the customer information. Everything inside these tags shows information about the customer.

      <Phone></Phone>

      Used to send messages using Twilio regarding order status to customer. Must include Country code and area code. Ex. 14075582354

      <Name>Pasta Salad Supreme</Name>

      Item name shown on order.

      <Category>Hot</Category>

      Category an item can be set to.

      <Quantity>1</Quantity>

      Sets and displays item quantity on order.

      <Color BG="10" FG="255"></Color>*

      256 colors, background, and foreground color value

      Note: Colors can also be set from app.

      <RGBColor></RGBColor>

      e.g.: <RGBColor BG="2254" FG="23255"></RGBColor>

      Use RGB colors for item/condiment background and foreground.

      If <Color> and <RGBColor> all existed, use the last one.

      Attribue: BG, FG

           It supports HTML color format:

      1. Color name, e.g: red, green.
      2. HEX number: e.g: #ff10fb
      3. Rgb number: e.g: rgb(255,0,0)
      4. Integer number. E.g: 12345

       

      <KDSStation>n:n</KDSStation>

      Or <KDSStation>n</KDSStation>

      n:0 or n:1, where n stands for which station you want the order to be, 0 stands for screen 1 and 1 stands for screen 2, split screen must be enabled to use this feature.

       

      If split screen is not being used then only the station id# needs to be entered in this field.

      <PreModifier> </PreModifier>

      Start & End of item PreModifier, everything inside these two tags are item PreModifier

      <Condiment></Condiment>

      Start & End of item condiment, everything inside these two tags are item condiment

      <Action>n</Action>

       

      Use in condiment, n=1 or -1 means add more condiment (+) or less condiment (-).

      <Modifier></Modifier>

      e.g.: <Modifier>

                 <ID>21</ID>

                <TransType>1</TransType>

                <Name>Modifier 01</Name>

               <Color BG="48" FG="100"></Color>

               <Action>1</Action>

               <KDSStation>1</KDSStation>

            </Modifier>

      It is almost same as condiments, just the name is different. It should attach to item.

      <QueueMsg></QueueMsg>

      In queue station, show this message in order panel. See Show queue display custom message property.

      <StationInfo></StationInfo>

      Will show POS message to KDS station.

      Ex.

      <StationInfo>

                <ID>1234</ID> 

                <StationId>1</StationId>

                <User>0</User>

                <Info>This is the message</Info>

      <StatonInfo>