Dear Guidewire,

To address your requirements, I chose an excerpt from an actual Technical Guide I wrote four years ago

for a new module to a product. (I was the Technical Lead for the project, responsible for the entire SDLC.)

I changed the company name to LOGO and the product name to XYZ, but kept the module's name, MDI. I

would have done a few things differently at the time, such as reducing the long method names, but was

following company standards.

The focus of the excerpt is six pages long, as indicated by the Topic Requirement column in the table

below. The topic requirements as specified are:

• RDB = relational databases

• PL = programming languages

• XML = XML

• API = web services

I have included this page and front matter (cover pages, a table of contents page, and a version history

page), for a total of 11 pages, to put things in perspective.

This PDF contains the following:

Description Topic Requirement Page in this PDF Printed Page Number

This page – 1 –

Technical Guide

Cover page, front and back – 2,3 1,2

Table of contents – 4 3

Version history – 5 4

Introduction PL, RDB (objects) 6 5

User Guide

First page RDB (entry) 7 6

XML example XML 8 12

API Reference Document

Class, first page only API, RDB (objects) 9 15

GetFacilities method* API, XML (with XSD) 10,11 18,19

*The module uses a SOAP API, not a REST API. So, we have methods, not endpoints.

I hope you like what you see,

Claire Streb

MDI Technical Guide User Guide v5, for use with MDI Release 11.2 and higher

Developer API Reference Document for MDI

12/23/2015

Claire Streb, MDI Technical Lead

Phone: 1.844.GO.LOGO Email: cxs2@LOGO.com

MDI Technical Guide | 2

© 2015 The LOGO Group, Inc.

All Rights Reserved

LOGO and XYZ are registered trademarks or service marks of The LOGO Group, Inc.

.

MDI Technical Guide | 3

Contents

Version History ______________________________________________________________________ 4

Menu Display Interface (MDI) __________________________________________________________ 5

Database Objects ____________________________________________________________________ 5

MDI User Guide ______________________________________________________________________ 6

XYZ Coding _______________________________________________________________________________ 6 Trait Coding (Optional) _____________________________________________________________________________ 6 Menu Detail Coding _______________________________________________________________________________ 6 Menu Item Selling Price and Course Coding ____________________________________________________________ 7 Nutritional Goal Coding ____________________________________________________________________________ 7

Service Menu Administrator Coding __________________________________________________________ 8 Facility Coding ____________________________________________________________________________________ 8 Service Units Coding _______________________________________________________________________________ 8 Service Courses Coding_____________________________________________________________________________ 9 Service Stations Coding ____________________________________________________________________________ 9 Menu Item Description Coding ______________________________________________________________________ 10 Service Menu Coding _____________________________________________________________________________ 10

XML Output Examples ____________________________________________________________________ 12

API Reference Document _____________________________________________________________ 13

LOGO.XYZ.Framework.LOGOWebData Namespace ________________________________________ 13

LOGOWebData Class _____________________________________________________________________ 15

LOGOWebData Methods __________________________________________________________________ 17

LOGOWebDataGetFacilities Method ________________________________________________________ 18

LOGOWebDataGetMDICategories Method ___________________________________________________ 20

LOGOWebDataGetMDIUnits Method _______________________________________________________ 22

LOGOWebDataGetMeals Method ___________________________________________________________ 24

LOGOWebDataGetMenuDetails Method _____________________________________________________ 26

LOGOWebDataGetMenuDisplays Method ___________________________________________________ 29

LOGOWebDataGetMenus Method __________________________________________________________ 31

LOGOWebDataGetNutritionalGoals Method _________________________________________________ 33

LOGOWebDataVersionInfo Method _________________________________________________________ 35

MDI Technical Guide | 4

Version History Version Date Detais Author

1.0 11/4/2015 Initial draft Claire Streb

2.0 11/26/2015 Addition of Trait to identify items for display Claire Streb

3.0 12/1/2015 Added XYZ section for coding Claire Streb

4.0 12/3/2015 Updated the XML samples. Added Nutritional Goal coding.

Claire Streb

5.0 12/23/2015 Updated for Branding Claire Streb

MDI Technical Guide | 5

Menu Display Interface (MDI) The Menu Display Interface (MDI) extracts service menu information stored in the XYZ database into XML results, from the SOAP web service, that your vendor parses and displays on a digital menu board system. Your vendor can use any programming language that uses a SOAP library, such as C#, Java, JavaScript, Python, PERL, and even VB6.

This Technical Guide contains:

A User Guide for your Administrator to set up the database for MDI

An API Reference Document for the vendor Developer to interact with MDI

Database Objects The XYZ database contains a long list of database objects. The following shows only those objects that pertain to MDI and how they relate to each other. These objects are used in the User Guide and the API Reference Document. The first page of the API Reference Document provides a detailed explanation of the objects and more information regarding their relationships.

Facility

MDI Unit

Menu Display

Service Menu

Menu Detail

Trait Nutritional Goal Meal

This Technical Guide is NOT MEANT TO REPLACE TRAINING. This Guide assumes you already know how to use the XYZ system and have been educated

in its nomenclature and operations.

MDI User Guide| 6

MDI User Guide This Guide explains how you must set up the database to get the desired results from MDI. Setting up the database is frequently called coding.

XYZ Coding

Trait Coding (Optional)

If you want to quickly identify items that appear on a menu board, or if you want to specify a way to filter items in the output, you can choose to assign all of the items a Menu Board trait. This is so that the trait can be assigned to all Menu Items that you wish to display on Menu Boards.

In XYZ: Setup > General Settings > Traits.

Select Filter by Category > General, click Add Trait, name it Menu Board, then click Save.

Menu Detail Coding

You can assign Traits to Menu Details to identify allergens and to identify items that should appear on a display board.

In XYZ: Item Maintenance, open an existing Item > General Tab > Traits sub-tab.

Select Add, and add the Menu Board Trait to each item that should appear on the menu board.

The Allergen traits can be used to trigger icons on the Menu Display.

API Reference Doc| 12

XML Output Examples The following is example output from requesting MDI version 11.12 for the menus. The API Reference Doc is the authoritative resource. It explains the XML in more detail, and later versions might contain different data. These examples provide you a general idea of what the vendor Developer should expect.

The following is example output generated from querying MDI for the menu details with nutrition.

API Reference Doc| 15

API Reference Doc| 18

API Reference Doc| 19