История страницы

Версия 1.2 от 10.4.2017

Содержание

Протокол обмена

Общее описание протокола и точки подключения

Grotem.Mobile имеет удобный API-интерфейс, позволяющий с помощью специальных запросов обмениваться данными со сторонними системами.

...

{идентификатор внешнего клиента} - уникальный идентификатор внешней БД. Должен быть уникальным и фискированным для каждой внешней системы.

Алгоритм синхронизации

Общее описание

При синхронизации сервер GROTEM.Mobile позволяет отслеживать изменения. Для этих целей у всех объектов в БД Grotem.Mobile используется служебное поле Timestamp, где хранится время последнего изменения. При обмене данными в структуре файла обмена предусмотрены поля TimestampFrom и TimestampTo.

...

КлиентКлиентСерверСерверВыборка данных и формирование файлаПередача сформированного JSON (HTTP-POST)Обработка полученных данных (обновление записей и Timestamp)Выборка и фильтрация измененийПодготовка файла ответаОтправка файла в теле ответа HTTP-Code: 200Обработка полученного файлаСохранение полученного TimestampTo (для передачи в следующем обмене)

Выгрузка связанных данных

У всех объектов БД добавлено служебное поле KeyFieldTimestamp. При выгрузке сервер анализирует значение времени в этом поле. И если хотя бы у одного объекта это поле попадает в условия выгрузки (KeyFieldTimestamp >= TimestampFrom):

...

Установка поля KeyFieldTimestamp может приводить к увеличению времени синхронизации.

Фильтрация данных

Для уменьшения объема передаваемых данных, а также для ограничения доступа к ним на стороне сервера используется фильтрация выгружаемых клиенту данных.

...

Фильтры формируются на этапе проектирования структуры данных. Текущие фильтры описаны в разделе “Типовые фильтры”.

Структура файла обмена

Общее описание

Файл обмена формируется и получается в JSON-формате (кодировка UTF-8).

...

• "Id" - уникальный идентификатор сессии обмена. По этому идентификатору также в дальнейшем можно получать информацию о сессии.
• "TimestampFrom" - начальная граница промежутка времени для получения изменений (см. “Общее описание алгоритма синхронизации”)
• "TimestampTo" - конечная граница промежутка времени для получения изменений (обычно сюда передается текущее время). Будет установлено в качестве метки времени “Timestamp” для всех объектов, переданных в файле
• "DeletedEntities"- список удаленных объектов (подробнее см. “Формат выгрузки объекта”)
• "ChangedEntities"- список измененных объектов (подробнее см. “Формат выгрузки объекта”)
• "FiltersToApply" - перечень фильтров (не используется и в текущей версии протокола игнорируется)

Формат выгрузки объекта

Для передачи в файле обмена в секциях "DeletedEntities" и "ChangedEntities" используются списки объектов. Каждый элемент списка представляет собой следующий формат

...

• Обязательные поля для всех объектов (независимо от типа)

  • "Id" - Идентификатор объекта (в формате GUID)
  • "IsDeleted" - признак удаления объекта (такие объекты будут удалены из БД)
  • "Timestamp" - метка времени изменения объекта
  • "Tablename" - имя таблицы, к которой принадлежит объект (подробнее см. “Описание таблиц и полей”)
  • "SyncFilter" - в текущей версии протокола не используется и игнорируется

• "Fields" - поля объекта, характерные для каждой таблицы (подробнее см. “Описание таблиц и полей”)

Пример файла выгрузки

Приведенный пример отображает передачу / получение измененных объектов таблиц:

• Клиент
• Список контактов, связанных с клиентом
• Контактные лица

{
    "Id": "055c2053-8e2f-4b78-b83f-f60b9ecff815", 
    "TimestampFrom": 0,
    "TimestampTo": 636219989844656600,
    "DeletedEntities": [],
    "ChangedEntities": [
        {
            "Id": "f4a4d5d0-1dd3-11e6-b0e7-6c71d97753d2",
            "IsDeleted": false,
            "Timestamp": 636219989755439200,
            "Tablename": "Catalog.Client",
            "SyncFilter": null,
            "Fields": {
                "Id": "f4a4d5d0-1dd3-11e6-b0e7-6c71d97753d2",
                "IsDeleted": false,
                "Timestamp": 636219989755439200,
                "KeyFieldTimestamp": 636217442594783700,
                "Predefined": false,
                "DeletionMark": false,
                "Description": "Иванов Михаил Петрович",
                "Code": "000000003",
                "Latitude": 0,
                "Longitude": 0,
                "Address": "г. Санкт-Петербург, ул. Почтамтская, д. 3-5",
                "Contractor": null
            }
        },
        {
            "Id": "9e0d9b3d-71ef-4568-810f-d8e2bfdea923",
            "IsDeleted": false,
            "Timestamp": 636217442594783700,
            "Tablename": "Catalog.Client_Contacts",
            "SyncFilter": null,
            "Fields": {
                "Id": "9e0d9b3d-71ef-4568-810f-d8e2bfdea923",
                "IsDeleted": false,
                "Timestamp": 636217442594783700,
                "KeyFieldTimestamp": 636217442594783700,
                "Ref": "f4a4d5d0-1dd3-11e6-b0e7-6c71d97753d2",
                "LineNumber": 1,
                "Contact": "f4a4d5cd-1dd3-11e6-b0e7-6c71d97753d2",
                "Actual": false
            }
        },
        {
            "Id": "f4a4d5cd-1dd3-11e6-b0e7-6c71d97753d2",
            "IsDeleted": false,
            "Timestamp": 636217442594783700,
            "Tablename": "Catalog.Contacts",
            "SyncFilter": null,
            "Fields": {
                "Id": "f4a4d5cd-1dd3-11e6-b0e7-6c71d97753d2",
                "IsDeleted": false,
                "Timestamp": 636217442594783700,
                "KeyFieldTimestamp": 636217442594783700,
                "Predefined": false,
                "DeletionMark": false,
                "Description": "Иванов Михаил",
                "Code": "000000002",
                "Position": "",
                "Tel": "+7 (812) 325-49-49",
                "EMail": ""
            }
        }
    ],
    "FiltersToApply":[]
}

Примеры отправки запроса (полная синхронизация)

В приведенных ниже примерах HTTP-заголовок для авторизации ‘authorization’ считаем заранее известным

Предполагаем, что точка входа находится по адресу http://server.ru/grotem/admin/SyncSolutionDatabase

...

var client = new RestClient("http://server.ru/grotem/admin/SyncSolutionDatabase");
var request = new RestRequest(Method.POST);
request.AddHeader("authorization", "Basic RGV2MTpEZXYx")
       .AddHeader("configversion", "1.1.0.0")
       .AddHeader("configname", "GrotemExpress")
       .AddHeader("content-type", "application/json")
       .AddHeader("deviceId", "66baa76a-71fe-4395-b4a6-0b77bee9526d")
       .AddParameter("application/json", "{\"Id\":\"f8685de0-b174-44ea-9d89-b36bab8e8043\",\"TimestampFrom\":0,\"TimestampTo\":636219988969526110,\"DeletedEntities\":[],\"ChangedEntities\":[],\"FiltersToApply\":[]}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

...

Описание таблиц и полей

Типы данных

Перечисления (ENum)

Для всех перечислений структура таблиц единая

Enum.ChequeType

Значения:

Enum.PositionPaymentType

...

Enum.CheckListStatus

Значения:

Enum.FoReminders

...

Enum.ResultEvent

Значения:

Enum.StatsNeedNum

Значения:

Enum.StatusEquipment

...

Enum.StatusImportance

Значения:

Enum.StatusTasks

Значения:

Enum.StatusyEvents

Значения:

Enum.TypesDataParameters

Значения:

Enum.TypesEvents

Значения:

Enum.VATS

...

Enum.Webactions

...

...

Catalog.Accounts

Список полей:

Catalog.Actions

Список полей:

Catalog.Actions_ValueList

...

Catalog.Client

...

Catalog.Client_Contacts

...

Catalog.Client_Files

...

Catalog.Client_Parameters

...

Catalog.ClientOptions

...

Catalog.ClientOptions_ListValues

...

Catalog.Contacts

Список полей:

Catalog.Equipment

...

Catalog.Equipment_Equipments

...

Catalog.Equipment_EquipmentsHistory

...

Catalog.Equipment_Files

...

Catalog.Equipment_Parameters

...

Catalog.EquipmentOptions

...

Catalog.EquipmentOptions_ListValues

...

Catalog.EventOptions

Список полей:

Catalog.EventOptions_ListValues

...

Catalog.ListOfPayments

...

Catalog.Positions

...

Catalog.RIM

...

Catalog.Roles

...

Catalog.RoleWebactions

...

Catalog.ServiceAgreement

...

Catalog.SettingMobileApplication

...

Catalog.SKU

...

Catalog.TypesDepartures

...

Catalog.User

...

Catalog.User_Bag

...

Catalog.User_RemainsNorms

...

...

Document.CheckList

...

Document.CheckList_Actions

...

Document.Event

...

Document.Event_CheckList

...

Document.Event_Equipments

...

Document.Event_EventFiskalProperties

...

Document.Event_Files

...

Document.Event_Parameters

...

Document.Event_Photos

...

Document.Event_ServicesMaterials

...

Document.Event_TypeDepartures

Document.Cheque

...

Document.Cheque_Nomenclature

...

Document.Cheque_Payment

...

Document.Cheque_ChequePhoto

...

Document.EventHistory

...

Document.NeedMat

...

Document.NeedMat_Matireals

...

Document.Reminder

...

Document.Reminder_Photo

...

Document.Task

...

Document.Task_Status

...

Document.Task_Targets

...

Типовые фильтры

Для уменьшения данных, хранимых на мобильном устройстве, а также для минимизации трафика при обмене между мобильным приложением и сервером в решении на таблицы накладываются дополнительные фильтры, отсекающие лишние данные.

...

Запрос для фильтрации (в формате SQL):

<отсутствует>

Настройки мобильного приложения

Настройки мобильного приложения являются общими для всех устройств и не зависят от текущего пользователя.

Версии документа и внесенные изменения

...