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

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

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

Що таке Razor

Razor — це синтаксис розмітки ASP.NET, який дозволяє вбудовувати серверний код (Visual Basic і C#) у веб-сторінки. У 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=“Cooking completion ticket" TemplateRootModel="true" CommentEn="Cooking complete ticket">
    <Include PropertiesGroupId="CommonChequeProperties" />
    <Property Name="CookingPlace" Type="RestaurantSection" Nullness="NotNull" Comment=“Ticket cooking place" CommentEn="Production place ticket" />
    <Property Name="Order" Type="KitchenOrder" Nullness="NotNull" Comment=“Order" CommentEn="Order" />
    <Property Name="Item" Type="KitchenOrderItem" Nullness="NotNull" Comment=“Ticket item" CommentEn="Order item ticket" />
    <Property Name="CompoundItemSecondaryComponent" Type="KitchenOrderProductItem" Nullness="CanBeNull"
              Comment=“Right pizza half, for which the ticket is printed"
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=“Section">
    <Property Name="Name" Type="string" Nullness="NotNull" Comment=“Section name" />
    <Property Name="PrintProductItemCommentInCheque" Type="bool" Comment=“Whether or not a menu item comment should be printed on the receipt" />
    <Property Name="PrintBarcodeInServiceCheque" Type="bool" Comment="Whether or not a menu item barcode should be printed on the service ticket" />
    <Property Name="DisplayGuests" Type="bool" Comment=“Whether or not guests should be displayed in this section" />
    <Property Name="PrintSummaryServiceCheque" Type="bool" Comment=“Whether a consolidated service ticket (true) or section service ticket (false) should be printed in the section" />
</Model>

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

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

Що є в папці:

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

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

Доступ до POS-об'єктів Syrve

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

// Get all orders that are not deleted and not linked to the reservations/banquets that never got underway per till shift
IEnumerable<IOrder> GetAllNotDeletedNotBoundToNonStartedReservesOrdersBySession([NotNull] ICafeSession session);
// Get all undeleted sections with tables in the group
IEnumerable<IRestaurantSection> GetAllNotDeletedSectionsWithAnyTablesByGroup([NotNull] IGroup group);
// Get all payment methods
IEnumerable<IPaymentType> GetAllPaymentTypes();
// Get all payment systems
IEnumerable<IPaymentSystem> GetAllPaymentSystems();
// Get all undeleted delivery orders
IEnumerable<IDelivery> GetAllNotDeletedDeliveries();
// Get all problematic operations
IEnumerable<ICommonGroup> GetProblemOperationsEvents(bool allTerminalsEvents, DateTime dateBegin, DateTime dateEnd);

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

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

// Get all item sales events per till shift
IEnumerable<IItemSaleEvent> GetItemSaleEventsBySession([NotNull] ICafeSession session);
// Get all deposit and withdrawal events per till shift
IEnumerable<IPayInOutEvent> GetPayInOutEventsBySession([NotNull] ICafeSession session);

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

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

// Get all order payment transactions
IEnumerable<IOrderPaymentTransaction> GetOrderPaymentTransactions();
// Get all order payment transactions per till shift
IEnumerable<IOrderPaymentTransaction> GetOrderPaymentTransactionsBySession([NotNull] ICafeSession session);
// Get all fiscal deposit and withdrawal transactions per till shift
IEnumerable<IPayInOutFiscalTransaction> GetPayInOutFiscalTransactionsBySession([NotNull] ICafeSession session);
// Get all order payment transactions from the order closing details
IEnumerable<IOrderPaymentTransaction> GetOrderPaymentTransactionsByOrderCloseInfo([NotNull] IOrderCloseInfo orderCloseInfo);

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

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

// Run the OLAP report according to settings
IOlapReport BuildReport([NotNull] OlapReportSettings reportSettings);
// Run several OLAP reports according to the list of settings
List<IOlapReport> BuildReports([NotNull] IEnumerable<OlapReportSettings> reportsSettings);

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

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

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

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

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

• var settings = Model.ReportSettings;
  // Get the boolean value by the parameter
  if (settings.GetBool("ShowOneDishPrice"))
      // Show item unit price

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

• var settings = Model.ReportSettings;
  // Get the boolean value by the parameter
  if (settings.GetBool("ShowOneDishPrice"))
      // Show item unit price

• Період

• var settings = Model.ReportSettings;
  // Get the period start date
  var periodBegin = settings.GetPeriodBegin("ReportInterval");
  // Get the period end date
  var periodEnd = settings.GetPeriodEnd("ReportInterval");

• Рядок

• var settings = Model.ReportSettings;
  // Get the string parameter “str”
  var myStr = (string)settings.GetValue("str");

• Число

• var settings = Model.ReportSettings;
  // Get the numeric parameter “number” (where Format is a fractional number or amount)
  var myNumber = (decimal)settings.GetValue("number");
  // Get the numeric parameter “number” (where Format is an integer number)
  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(“Even orders don’t need to be printed");
    }
}

@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(“Do not print kitchen ticket for even orders")
        }
        @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>