Як скласти шаблони чеків і звітів Razor

Швидке переміщення по статті:

• Моделі та шаблони звітів
  • Доступ до сутностей Syrve POS
  • Доступ до подій Syrve POS
  • Доступ до транзакцій Syrve POS
  • Доступ до OLAP-звітів сервера
• Налаштування та параметри Razor-звітів
• Допоміжні функції для чеків і звітів
• Скасування друку в шаблоні
• Галерея шаблонів

     Що таке Razor

     Razor - це синтаксис розмітки, заснований на технології ASP.NET. В Syrve Razor вбудовується в код xml, який надсилається на принтери. 

     Схема друку Razor-шаблонів: Data → Razor template → View XML (наша розмітка для друку) → Друк. 

     Моделі та шаблони чеків

     У кожного чека своя модель даних. Моделі даних постачаються разом із дистрибутивом Syrve. Усі моделі та шаблони чеків зберігаються у папці \Resources\Cheques\RazorTemplates у котрій знаходиться: 

• TemplateModels.xml - у файлі зберігаються моделі чеків. Моделі чеків містять у собі класи Syrve POS і серверні класи. Тут описані тільки класи Syrve POS. 
• RmsEntityWrappers.xml - у файлі описані серверні класи. 
• файли *.cshtml - шаблони чеків, які можна використовувати. 

Розберемо на прикладі чека для закінчення приготування. 

     У файлі TemplateModels.xml є модель CookingCompleteCheque: 

<Model Name="CookingCompleteCheque" Comment=“Чек про закінчення приготування страви" TemplateRootModel="true" CommentEn="Cooking complete ticket"> <Include PropertiesGroupId="CommonChequeProperties" /> <Property Name="CookingPlace" Type="RestaurantSection" Nullness="NotNull" Comment=“Місце приготування, для котрого друкується чек" CommentEn="Production place ticket" /> <Property Name="Order" Type="KitchenOrder" Nullness="NotNull" Comment=“Замовлення" CommentEn="Order" /> <Property Name="Item" Type="KitchenOrderItem" Nullness="NotNull" Comment=“Елемент замовлення, для котрого друкується чек" CommentEn="Order item ticket" /> <Property Name="CompoundItemSecondaryComponent" Type="KitchenOrderProductItem" Nullness="CanBeNull"
              Comment=“Права половинка розділеної піци, для котрої друкується чек"CommentEn="Right half of divided pizza for which ticket is printed" /></Model>

     У тезі <Model> є атрибут TemplateRootModel = "true". Він показує, що в елементі <Model> описується модель чека. 

     У шаблоні чека CookingCompleteCheque.cshtml вкажемо, яку модель використовуємо: 

@inherits TemplateBase<ICookingCompleteCheque>

     У шаблон можна під'єднати поля і групи полів чека. У прикладі нижче підключена група полів CommonChequeProperties. Описи полів і груп можна знайти в TemplateModels.xml. 

include PropertiesGroupId="CommonChequeProperties" />

     Властивості Order і Item є об'єктами Syrve POS класів KitchenOrder і KitchenOrderItem, які описані в TemplateModels.xml. 

     Властивість CookingPlace є об'єктом класу RestaurantSection. Цей тип серверний, тому його опис можна знайти у файлі RmsEntityWrappers.xml.

<Model Name="RestaurantSection" Comment=“Відділення"> <Property Name="Name" Type="string" Nullness="NotNull" Comment=“Назва відділення" /> <Property Name="PrintProductItemCommentInCheque" Type="bool" Comment=“Чи потрібно друкувати коментар до елемента замовлення (страви) в чеку" /> <Property Name="PrintBarcodeInServiceCheque" Type="bool" Comment="Чи потрібно друкувати штрих-код до елемента замовлення (страви) в сервісному чеку" /> <Property Name="DisplayGuests" Type="bool" Comment=“Чи потрібно показувати гостей у даному відділенні" /> <Property Name="PrintSummaryServiceCheque" Type="bool" Comment=“Друкується у відділенні зведений сервісний чек (true) або сервісний чек відділення (false)" /></Model>

     Моделі та шаблони звітів

     Razor-звіти використовують єдину модель даних. Описи об'єктів і шаблони звітів  знаходяться в папці \Resources\Reports\Templates у котрій знаходяться наступні файли: 

• CashServerEntityWrappers.xml - опис об'єктів, які створюються в Syrve POS (замовлення, елемент замовлення тощо). Їх можна використовувати у звітах. 
• RmsEntityWrappers.xml - опис об'єктів, які створюються на сервері (продукт, користувач, група, відділення тощо). 
• EventWrappers.xml - опис подій Syrve POS. 
• TransactionWrappers.xml - опис транзакцій Syrve POS. 
• файли *.cshtml - це шаблони звітів. 

Модель даних Razor-звітів: 

Доступ до сутностей Syrve POS 

     У моделі звіту поле Entities дає можливість отримати списки різних сутностей Syrve POS (замовлення, операції, типи оплати тощо). 

// Отримати всі замовлення, які не видалені та не пов'язані з бронюваннями/банкетами, та котрі не були закриті за касову зміну IEnumerable<IOrder>
GetAllNotDeletedNotBoundToNonStartedReservesOrdersBySession([NotNull] ICafeSession session);// Отримати всі не видалені відділення зі столами за групоюIEnumerable<IRestaurantSection> GetAllNotDeletedSectionsWithAnyTablesByGroup([NotNull] IGroup group);// Отримати всі типи оплатIEnumerable<IPaymentType> GetAllPaymentTypes();// Отримати всі системи оплатIEnumerable<IPaymentSystem> GetAllPaymentSystems();// Отримати всі не видалені замовлення доставкиIEnumerable<IDelivery> GetAllNotDeletedDeliveries();// Отримати всі проблемні операціїIEnumerable<ICommonGroup> GetProblemOperationsEvents(bool allTerminalsEvents, DateTime dateBegin, DateTime dateEnd);

Доступ до подій Syrve POS 

     У моделі звіту поле Events дає можливість отримати списки різних подій Syrve POS.

// Отримати всі події продажів за касову зміну IEnumerable<IItemSaleEvent> GetItemSaleEventsBySession([NotNull] ICafeSession session);// Отримати всі події внесень та вилучень за касову змінуIEnumerable<IPayInOutEvent> GetPayInOutEventsBySession([NotNull] ICafeSession session);

Доступ до транзакцій Syrve POS 

     У моделі звіту поле Transactions дає можливість отримати списки різних транзакцій Syrve POS. 

// Отримати всі транзакції оплати замовленьIEnumerable<IOrderPaymentTransaction> GetOrderPaymentTransactions();// Отримати всі транзакції оплати замовлень за касову змінуIEnumerable<IOrderPaymentTransaction> GetOrderPaymentTransactionsBySession([NotNull] ICafeSession session);// Отримати всі фіскальні транзакції внесень та вилучень за касову змінуIEnumerable<IPayInOutFiscalTransaction> GetPayInOutFiscalTransactionsBySession([NotNull] ICafeSession session);// Отримати всі транзакції оплати замовлень з інформацією про закриття замовленняIEnumerable<IOrderPaymentTransaction> GetOrderPaymentTransactionsByOrderCloseInfo([NotNull] IOrderCloseInfo orderCloseInfo);

Доступ до OLAP-звітів сервера 

     У моделі звіту поле OlapReports дає можливість отримати дані з серверного OLAP-звіту і вбудувати їх. У цього поля доступні методи: 

// Отримати OLAP-звіт відповідно до налаштуваньIOlapReport BuildReport([NotNull] OlapReportSettings reportSettings);// Отримати декілька OLAP-звітів відповідно до списку налаштуваньList<IOlapReport> BuildReports([NotNull] IEnumerable<OlapReportSettings> reportsSettings);

     Налаштування та параметри Razor-звітів

     Деякі параметри впливають на дані та розмітку звіту. За допомогою поля ReportSettings у моделі можна отримувати доступи до параметрів в Syrve Office і Syrve POS. 

     Щоб отримати значення параметра, потрібно знати його ім'я і тип даних. Від типу даних (перерахування, логічна величина, період, рядок, число) залежить те, як значення буде отримано. 

     Як отримати значення: 

• Перерахування
  

  var settings = Model.ReportSettings;// Отримати значення перерахування за назвою параметра і порівняти його з одним із значеньif (settings.GetEnum("GroupDishes") == "GroupByDishes")
      // Згрупувати за стравами

• Логічна величина
  

  var settings = Model.ReportSettings;// Отримати логічне значення за параметромif (settings.GetBool("ShowOneDishPrice"))
      // Показати ціну за одиницю страви

• Період
  

  var settings = Model.ReportSettings;// Отримати дату початку періодуvar periodBegin = settings.GetPeriodBegin("ReportInterval");// Отримати дату закінчення періодуvar periodEnd = settings.GetPeriodEnd("ReportInterval");

• Рядок
  

  var settings = Model.ReportSettings;// Отримати рядковий параметр “str”var myStr = (string)settings.GetValue("str");

• Число
  

  var settings = Model.ReportSettings;// Отримати числовий параметр "number" (де Format - це дробове число або сума)var myNumber = (decimal)settings.GetValue("number");// Отримати числовий параметр "number" (де Format - ціле число)myNumber = (int)settings.GetValue("number");

     Додавання і редагування параметрів користувацького звіту описано в статті Звіти Syrve POS. 

     Допоміжні функції для чеків і звітів

     У чеках і звітах часто використовуються однакові блоки коду: округлення грошових одиниць, форматування дат, ваги, отримання всіх елементів замовлення, суми ПДВ, суми передоплат замовлення тощо. Для уникнення помилок і повторень блоки коду були винесені в окремі методи. Деякі методи можна використовувати тільки для чеків або звітів, а деякі - для того й іншого. 

     Скасування друку в шаблоні

     Друк чека або звіту можна скасувати в шаблоні, викинувши OperationCanceledException з текстом винятку. У print-templates.log запишеться повідомлення Template running was canceled. Message: {0}, де {0} - текст винятку, який можна задати в шаблоні.

@inherits TemplateBase<IBillCheque>
@{
    var order = Model.Order;
    if (order.Number % 2 == 0)
    {
        throw new OperationCanceledException(“Другий чек замовлення не потрібно друкувати");
    }
}

@inherits TemplateBase<IServiceChequeBase>
 
@helper ThrowException(string message)
{
    throw new OperationCanceledException(message);
}
 <doc bell="" formatter="split">    @if (Model is IServiceCheque)
    {
        if (Model.Order.Number % 2 == 0)
        {
             @ThrowException(“Не друкуємо сервісний чек для парного замовлення")
        }
        @Service((IServiceCheque)Model)
    }
    else if (Model is IBanquetServiceCheque)
    {
        @Banquet((IBanquetServiceCheque)Model)
    }
    else if (Model is IDeleteProductsServiceCheque)
    {
        @DeleteProducts((IDeleteProductsServiceCheque)Model)
    }
    else if (Model is IDeleteModifiersServiceCheque)
    {
        @DeleteModifiers((IDeleteModifiersServiceCheque)Model)
    }
    else if (Model is IProductsServeCheque)
    {
        @ProductsServe((IProductsServeCheque)Model)
    }
    else if (Model is IWholeCourseServeCheque)
    {
        @WholeCourseServe((IWholeCourseServeCheque)Model)
    }
    else
    {
        throw new NotSupportedException(string.Format("Invalid model type '{0}'", Model.GetType()));
    }</doc>

     Галерея шаблонів

     У Галереї шаблонів можна вибрати та відредагувати чек із уже готових прикладів. Збережіть налаштування шаблону, завантажте його у свій ресторан і починайте користуватися. 

Як користуватися

     Галерея шаблонів знаходиться в Адміністрування → Шаблони чеків. 

1. Натисніть Додати і перейдіть у вкладку Галерея шаблонів. 
2. Натисніть Вибрати навпроти потрібного шаблону. 

     Якщо потрібно щось змінити, зробіть це у вкладці Текст шаблону. Якщо шаблон буде не основним, зніміть галочку з параметра Основний. Збережіть зміни.