Overview
The Digital Recipe Cards functionality is a web application that allows the user to search and view recipe data from an existing Recipe & Menu Engineering (formerly known as StarChef.NET) database.
Requirements
-
The following browsers and devices have been tested with Digital Recipe Cards in RME:
-
Microsoft Internet Explorer 8 and above
-
Mozilla Firefox 6.0.2
-
Google Chrome 13.0.782.220
-
Apple Safari 5.1
-
Apple iPhone
-
Apple iPad
-
-
JavaScript must be enabled for all platforms.
-
Digital Recipe Cards in RME requires a StarChef.NET database with system users able to manage ingredient and recipes entries
Global Database Setting
- The functionality is configured from the Global Database Settings section of StarChef.NET
Setting | Description |
Supplier User Group Type Enabled | Required: Must be checked. Please Note: There is a feature open to rename this setting to 'User Group Type Enabled'. |
Digital Recipe Cards (Located in the right hand list of Global Database settings) | |
Digital Recipe Cards User Group Type Enabled | Required: Must be checked. |
Show Recipe Thumbnails | Optional: Display recipe images on search results. |
Recipe User Ratings | Optional: Can be set to blank (none), 'user' or 'user and average' as required. |
Print and Save enabled | Optional: Display print and PDF buttons on Recipe Card screen. |
Recipe Ratings
-
There are three options for Recipe User Ratings in the Digital Recipe Cards functionality, which are configured from Global Database Settings:
-
Blank (None): This will not enable any User Ratings functionality
-
User Only: This will only allow the user to view and set individual ratings for each recipe
- User and Average: This extends User Ratings so that an average rating value is displayed for recipes
-
Please Note: An average rating for a recipe is only calculated once five User Ratings have been submitted.
If the Average Recipe Ratings functionality is required, the following recipe report must be set to visible for the database:
-
User Rating Summary - This report displays a table of recipes showing the number of ratings submitted and the average recipe rating value for each recipe. This report is designed so that StarChef.NET users can export and analyse recipe rating information
Groups and User Groups
-
A StarChef.NET group must be created, which is linked to the required recipe and ingredient sets. A logo image file must be uploaded for each group in the following value Settings > Group Logo
-
The group logo will not be resized by the Recipe & Menu Engineering solution, so it must have appropriate dimensions for displaying on the Digital Recipe Cards search page. It is recommended that the group logo does not exceed 450px (W) and 90px (H)
-
User groups must be linked to the appropriate Digital Recipe Cards group, ensuring that the user group setting Details > User group type has a value of ‘StarChef Lite’. Once the user group type of ‘StarChef Lite’ has been set then only the following permissions will be available for the user group.
Permission | Description |
Nutrition Permissions | |
View Nutrition | Optional: Displays Nutrition and Intolerance data on the Recipe Card screen. |
Recipe & Menus Light (formerly known as Starchef Light) Permissions | |
View Ingredient Pricing | Optional: Display cost value for each Recipe ingredient. |
View Pricing Totals | Optional: Display total cost of ingredients value for the Recipe. If checked, then 'View Ingredient Pricing' will also be automatically checked. |
View Creation Details | Optional: Display 'Chef's Name' value on search results and the Recipe Card screen. |
View Mise en Place | Optional: Display Mise en Place text box on Recipe Card screen. |
View CCP | Optional: Display 'Critical Control Points CCP' text box on Recipe Card screen |
Users
-
Users who need access to the Light version of Recipe and Menus should be added to a 'Light' type User Group, e.g. RME Recipe Viewer. It is possible for a user to belong to User Groups of type ‘Standard’ and ‘Recipe and Menus Lite’. StarChef.NET will use the default user group value for the user to determine which application to automatically direct the user to when they login.
-
If the Light User Group is an additional User Group, the user will be directed to the Light view if they change to this User Group on the Home page. This is a one-way trip; once in Recipe and Menus Light, the user must return to the Recipe and Menus solution and re-login in order to log back into the core solution.
-
For Recipe and Menus Light deployments where Recipe creation details are to be displayed, then the following details for each user who creates Recipes in this version of Recipe and Menus should be populated:
User Value | Guidelines |
Details | |
Forename | Required |
Surname | Required |
Required | |
Telephone | Recommended |
Description | Recommended |
User Image | Recommended |
Recipe Nutrition and Intolerance Data
-
Should Nutritional Information be required for the Digital Recipe Cards / Recipe & Menus Light deployment (configured using User Group permissions), then Nutrition and Intolerance values should be set for all Recipes
-
Both the 'Light' and core Recipe and Menus solutions use the same list of Nutrition and Intolerance values. Nutritional data values can be hidden or renamed as required. By default, the list of intolerance items is very long, and so it is recommended that items which are not going to be populated should be hidden on the database. In order for the advanced recipe search filters to work the following intolerance values are required:
-
Contains Milk or Milk Products
-
Contains Fish or Fish Products
-
Contains Crustaceans or Shellfish
-
Contains Nuts or Nut Trace
-
Contains Nuts or Nut Trace > Peanuts
- Contains Soya
- Suitable for Vegetarians
-
Please Note: Changing resource strings or visibility of Nutritional and Intolerance items will require chargeable development work.
Recipes
-
The following guidelines should be followed in order to optimise the Digital Recipe Cards user experience. Recipes should be reviewed before deployment to ensure that the values below are populated:
Recipe Value | Guidelines |
Details | |
Recipe Name | Required: The length of this value is not limited by default, but it can be limited using the Global Database Setting titled 'Recipe Name Maximum Length'. Very long Recipe names with no spaces should be avoided as these can cause text wrapping issues. |
Description | Required: Descriptions over 160 characters will be truncated. |
Preparation Time | Recommended |
Cooking Time | Recommended |
Ingredients | |
Ingredient Name | Required: The length of this value is limited to 150 characters by default. This can be modified on the Global Database Setting in the Ingredients tab. |
Ingredient Quantity | Required: Values rounded to 2 decimal places, uses the Unit of Measurement short code |
Ingredient Cost | Required: If pricing User Group permissions are used, then ingredients must have Supply Cost values. Ingredient costs are rounded to 2 decimal places |
Yield | |
Servings | Recommended |
Portion Size | Recommended |
Preparation | |
Method | Optional |
Mise en Place | Optional - Recommended if Mise en Place User Group permissions are used |
Critical Control Points | Optional - Recommended if 'View CCP' User Group permissions are used |
Categories | Recommended - Allows the user to filter Recipes by any of the Category values which have been assigned to the Recipe |
Picturres | Recommended - Recipe images will be resized to 400px (W) x 240px (H) on the Recipe Card screen |
Comments
0 comments
Please sign in to leave a comment.