AutoGRAPH.NET Service — различия между версиями

Материал из TK
Перейти к: навигация, поиск
Строка 73: Строка 73:
 
*[[AutoGRAPH.NET Service EnumSchemas|EnumSchemas]] – получение списка доступных сервису схем
 
*[[AutoGRAPH.NET Service EnumSchemas|EnumSchemas]] – получение списка доступных сервису схем
 
*[[AutoGRAPH.NET Service EnumDevices|EnumDevices]] – получение списка устройств схемы
 
*[[AutoGRAPH.NET Service EnumDevices|EnumDevices]] – получение списка устройств схемы
*[[AutoGRAPH.NET Service EnumDrivers|EnumDrivers]] [[File:Tag-new.png]] – получение информации о водителях в схеме
+
*[[AutoGRAPH.NET Service EnumDrivers|EnumDrivers]]  – получение информации о водителях в схеме
 
*[[AutoGRAPH.NET Service EnumGeoFences|EnumGeoFences]] – получение списка геозон схемы
 
*[[AutoGRAPH.NET Service EnumGeoFences|EnumGeoFences]] – получение списка геозон схемы
*[[AutoGRAPH.NET Service GetGeoFences|GetGeoFences]] [[File:Tag-new.png]] – получение информации о геозонах (точки для полигонов и т.д.)
+
*[[AutoGRAPH.NET Service GetGeoFences|GetGeoFences]]  – получение информации о геозонах (точки для полигонов и т.д.)
 
*[[AutoGRAPH.NET Service GetDevicesInfo|GetDevicesInfo]] – получение информации об устройстве в схеме
 
*[[AutoGRAPH.NET Service GetDevicesInfo|GetDevicesInfo]] – получение информации об устройстве в схеме
 
*[[AutoGRAPH.NET Service EnumParameters|EnumParameters]] – получение списка параметров устройства в схеме
 
*[[AutoGRAPH.NET Service EnumParameters|EnumParameters]] – получение списка параметров устройства в схеме
 
*[[AutoGRAPH.NET Service GetOnlineInfo|GetOnlineInfo]] – получение информации о последнем местоположении устройств
 
*[[AutoGRAPH.NET Service GetOnlineInfo|GetOnlineInfo]] – получение информации о последнем местоположении устройств
*[[AutoGRAPH.NET Service GetOnlineInfoAll|GetOnlineInfoAll]] [[File:Tag-new.png]] – получение информации о последнем местоположении всех устройств
+
*[[AutoGRAPH.NET Service GetOnlineInfoAll|GetOnlineInfoAll]]  – получение информации о последнем местоположении всех устройств
 
*''GetDataRanges – получение информации о загруженных данных для приборов (минимальная/максимальные доступные даты)''
 
*''GetDataRanges – получение информации о загруженных данных для приборов (минимальная/максимальные доступные даты)''
 
*[[AutoGRAPH.NET Service GetTrips|GetTrips]] – получение информации о рейсах устройства с текущими настройками схемы
 
*[[AutoGRAPH.NET Service GetTrips|GetTrips]] – получение информации о рейсах устройства с текущими настройками схемы
Строка 88: Строка 88:
 
*[[AutoGRAPH.NET Service GetProperty|GetProperty]] – получение значения одного свойства у списка приборов
 
*[[AutoGRAPH.NET Service GetProperty|GetProperty]] – получение значения одного свойства у списка приборов
 
*[[AutoGRAPH.NET Service GetRoute|GetRoute]] – прокладка маршрута и получение этой информации в виде набора точек
 
*[[AutoGRAPH.NET Service GetRoute|GetRoute]] – прокладка маршрута и получение этой информации в виде набора точек
  +
*[[AutoGRAPH.NET Service WaitData|WaitData]] [[File:Tag-new.png]] - ожидание получения новых данных
*[[AutoGRAPH.NET_Service EnumReports|EnumReports]] - получение списка доступных отчетов
 
  +
*[[AutoGRAPH.NET_Service GetReports|GetReports]] - выполнение отчета и загрузка его в виде XML/PDF/DOCX/XLS/.../ZIP-файла (формат выполнения указывается)
 
  +
*[[AutoGRAPH.NET Service EnumReports|EnumReports]] [[File:Tag-new.png]] - получение списка доступных отчетов
*[[AutoGRAPH.NET_Service ExecuteReports|ExecuteReports]] - асинхронное выполнение отчета(ов)
 
  +
*[[AutoGRAPH.NET Service GetReports|GetReports]] [[File:Tag-new.png]] - выполнение отчета и загрузка его в виде XML/PDF/DOCX/XLS/.../ZIP-файла (формат выполнения указывается)
*[[AutoGRAPH.NET_Service GetReportsStatus|GetReportsStatus]] - получение состояния выполнения отчета(ов)
 
  +
*[[AutoGRAPH.NET Service ExecuteReports|ExecuteReports]] [[File:Tag-new.png]] - асинхронное выполнение отчета(ов)
  +
*[[AutoGRAPH.NET Service GetReportsStatus|GetReportsStatus]] [[File:Tag-new.png]] - получение состояния выполнения отчета(ов)
 
*''CancelReports - отмена выполнения отчета''
 
*''CancelReports - отмена выполнения отчета''
   

Версия 17:28, 22 июля 2015

Сервис предоставляет WCF/JSON API для доступа ядру расчетов AutoGRAPH.NET. Конфигурация схем выполняется с помощью диспетчерского ПО AutoGRAPH.NET. Работает в двух режимах – консольном и как сервис.

Минимальные требования к аппаратному и программному обеспечению

Загрузка

Последняя версия: 2015.7.18.1, загрузить

Режим консоли

В основном предназначен для отладки и тестирования. Достаточно просто запустить файл AutoGRAPHNETService.exe.

Режим сервиса

Устанавливается как сервис (служба) Windows и работает автономно. Командная строка для установки:

sc create AutoGRAPHNETService binPath= "C:\TK\WebMapK\Build-Svc\AutoGRAPHNETService.exe"

 между binPath= и полным путем - пробел 

Описание работы

После распаковки AutoGRAPH.NET Service в какой-нибудь каталог необходимо отредактировать файл AutoGRAPHNETService.exe.config. Далее приведены описания ключей файла конфигурации:

<add key="key-file" value="N:\Ключи АвтоГРАФ-Сервер\AutoGRAPHServer_3.0\30008_4x4_magnitka.agkey"/>
<add key="address" value="http://localhost:800/"/>
<add key="address-json" value="http://localhost:810/"/>
<add key="common-directory" value="C:\ProgramData\AutoGRAPH Shell"/>
<add key="data-directory" value="C:\Users\denisio\AppData\Roaming\AutoGRAPH Shell\Data"/>
key-file файл ключа .agkey (от AutoGRAPH.Server), который разрешает использования для прописанного списка приборов. Данный файл находится в каталоге AutoGRAPH.Server.
Обязательный параметр! Без него сервис работать не будет.
address локальный адрес, на котором обрабатываются запросы по протоколу WCF (в настоящий момент протестирован только механизм httpBinding). Формат - url:port
Варианты использования:
  • http://192.168.1.3:8000 - принимать подключения на локальном IP-адресе 192.168.1.3 и TCP-порт 8000 (обычно данный вариант используется, если в сервере установлено несколько сетевых карт или задано несколько IP-адресов)
  • http://0.0.0.0:8000 или http://*:8000 - принимать подключения на всех доступных локальных IP-адресах и TCP-порту 8000
  • http://127.0.0.1:8000 - принимать подключения только локально
address-json локальный адрес, на котором обрабатываются запросы по протоколу JSON. Формат - url:port
Варианты использования:
  • http://192.168.1.3:8000 - принимать подключения на локальном IP-адресе 192.168.1.3 и TCP-порт 8000 (обычно данный вариант используется, если в сервере установлено несколько сетевых карт или задано несколько IP-адресов)
  • http://0.0.0.0:8000 или http://*:8000 принимать подключения на всех доступных локальных IP-адресах и TCP-порту 8000
  • http://127.0.0.1:8000 - принимать подключения только локально
common-directory
каталог с общими данными (структура каталога аналогична каталогу AutoGRAPH.NET – с подкаталогами Schemes, GeoFences, Devices в которых находятся соответствующие файлы схем, геозон, приборов)
data-directory
каталог данных (=data-каталог) AutoGRAPH DataLoader или AutoGRAPH Server 3.x или 4.x или 5.x

После редактирования конфиг-файла можно запустить сервис (или консольно) и сделать запрос:

svcutil.exe http://localhost:800/?wsdl /async /tcv:Version35 /ser:DataContractSerializer


В данном случае будет создан файл AutoGRAPHSvc.cs с прокси-классом для доступа к WCF-точке сервиса AutGRAPH.NET Service и output.config файл с описанием параметров подключения WCF. Файл output.config в данном случае не используется.

Методы сервиса

  • EnumSchemas – получение списка доступных сервису схем
  • EnumDevices – получение списка устройств схемы
  • EnumDrivers  – получение информации о водителях в схеме
  • EnumGeoFences – получение списка геозон схемы
  • GetGeoFences  – получение информации о геозонах (точки для полигонов и т.д.)
  • GetDevicesInfo – получение информации об устройстве в схеме
  • EnumParameters – получение списка параметров устройства в схеме
  • GetOnlineInfo – получение информации о последнем местоположении устройств
  • GetOnlineInfoAll  – получение информации о последнем местоположении всех устройств
  • GetDataRanges – получение информации о загруженных данных для приборов (минимальная/максимальные доступные даты)
  • GetTrips – получение информации о рейсах устройства с текущими настройками схемы
  • GetTripsCustom Tag-new.png – получение информации о рейсах устройства с указанными геозонами
  • GetStage Tag-new.png – получение информации по одному отрезку для устройств
  • GetTrack – получение трека (даты/время, координаты, скорость) устройства с текущими настройками схемы
  • GetProperties – получение списка свойств и их значений устройства
  • GetProperty – получение значения одного свойства у списка приборов
  • GetRoute – прокладка маршрута и получение этой информации в виде набора точек
  • WaitData Tag-new.png - ожидание получения новых данных
  • EnumReports Tag-new.png - получение списка доступных отчетов
  • GetReports Tag-new.png - выполнение отчета и загрузка его в виде XML/PDF/DOCX/XLS/.../ZIP-файла (формат выполнения указывается)
  • ExecuteReports Tag-new.png - асинхронное выполнение отчета(ов)
  • GetReportsStatus Tag-new.png - получение состояния выполнения отчета(ов)
  • CancelReports - отмена выполнения отчета

Примеры

using System;
using System.Collections.Generic;
using System.Globalization;
using System.Linq;
using System.Text;
using AutoGRAPHService;

namespace AutoGRAPHSvcTest
{
    class Program
    {
        static void Main(string[] args)
        {
            var svc = new AutoGRAPHSvcClient();            // создаем прокси-класс с адресом подключения по умолчанию

            RSchema[] schemas;
            using (var f = new TimeCalc("EnumSchemas"))    // запрашиваем список доступных схем
               schemas = svc.EnumSchemas();

            REnumDevices devices;
            using (var f = new TimeCalc("EnumDevices"))
               devices = svc.EnumDevices(schemas[0].Name); // запрашиваем список доступных в схеме приборов
            foreach (var item in devices.Items)
               Console.WriteLine("\t" + item.Name);

            using (var f = new TimeCalc("EnumGeoFences"))  // запрашиваем список доступных в схеме геозон
               svc.EnumGeoFences(schemas[0].Name);
            using (var f = new TimeCalc("GetDevicesInfo"))
               svc.GetDevicesInfo(schemas[0].Name);
            
            using (var f = new TimeCalc("EnumParameters")) // запрашиваем список параметров для всех ТС в схеме
               svc.EnumParameters(schemas[0].Name, devices.Items.Select(p => p.ID).ToArray());
            
            using (var f = new TimeCalc("GetOnlineInfo"))  // запрашиваем онлайн-состояние всех ТС в схеме
               svc.GetOnlineInfo(schemas[0].Name, devices.Items.Select(p => p.ID).ToArray());
            
            using (var f = new TimeCalc("GetTrips"))       // запрашиваем список рейсов за последние 5 дней для всех ТС, с номерами начинающихся 9999998
                svc.GetTrips(schemas[0].Name,
                    devices.Items.Where(p => p.Serial >= 9999998).Select(p => p.ID).ToArray(),
                    DateTime.Now.AddDays(-5), DateTime.Now);
            
            using (var f = new TimeCalc("GetTrack"))       // запрашиваем треки за последние 5 дней для всех ТС, с номерами начинающихся 9999998
            {
                var t1 = svc.GetTrack(schemas[0].Name,
                    devices.Items.Where(p => p.Serial >= 9999998).Select(p => p.ID).ToArray(),
                    DateTime.Now.AddDays(-5), DateTime.Now);                
            }

            Console.ReadLine();
        }
    }

    // простой класс для замера скорости выполнения блока
    class TimeCalc:IDisposable
    {
        readonly DateTime DT;
        readonly string name;
        internal TimeCalc(string name) { DT = DateTime.Now; this.name = name; }
        void IDisposable.Dispose() { Console.WriteLine(name+": "+DateTime.Now.Subtract(DT).TotalSeconds.ToString("F3", CultureInfo.InvariantCulture)); }
    }
}

Файл .exe.config вышеприведенного примера

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
 <system.serviceModel>
 <bindings>
 <basicHttpBinding>
 <binding name="BasicHttpBinding_IAutoGRAPHSvc"
 closeTimeout="00:01:00" openTimeout="00:01:00" receiveTimeout="00:10:00" sendTimeout="00:01:00"
 allowCookies="false" bypassProxyOnLocal="false" hostNameComparisonMode="StrongWildcard"
 maxBufferPoolSize="524288" maxBufferSize="2147483647" maxReceivedMessageSize="2147483647"
 messageEncoding="Text" textEncoding="utf-8" transferMode="Buffered" useDefaultWebProxy="true">
 <readerQuotas maxDepth="32" maxStringContentLength="2147483647" maxArrayLength="16348"
 maxBytesPerRead="4096" maxNameTableCharCount="16384" />
 <security mode="None">
 <transport clientCredentialType="None" proxyCredentialType="None" realm="" />
 <message clientCredentialType="UserName" algorithmSuite="Default" />
 </security>
 </binding>
 </basicHttpBinding>
 </bindings>
 <client>
 <endpoint address="http://localhost:800/" binding="basicHttpBinding"
 bindingConfiguration="BasicHttpBinding_IAutoGRAPHSvc" contract="IAutoGRAPHSvc"
 name="BasicHttpBinding_IAutoGRAPHSvc" />
 </client>
 </system.serviceModel>
</configuration>

Данный конфигурационный файл содержит WCF-конфигурацию для точки подключения сервиса. По умолчанию используется HTTP binding, но ровно таким же способом можно включить и and Answers&referringTitle=Home=Home другие транспорты.

Диагностика неисправностей

Список возможных ошибок и особенностей конфигурации приведён здесь.