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

Материал из TK
Перейти к: навигация, поиск
 
(не показаны 94 промежуточные версии 4 участников)
Строка 1: Строка 1:
−
Сервис предоставляет WCF/JSON API для доступа ядру расчетов [[AutoGRAPH.NET]]. Конфигурация схем выполняется с помощью диспетчерского ПО AutoGRAPH.NET. Работает в двух режимах – консольном и как сервис.
 +
Сервис предоставляет WCF/JSON API для доступа ядру расчетов [[AutoGRAPH.NET|AutoGRAPH.Pro]]. Сервис обычно используется для интеграции в сторонние системы. Конфигурация схем выполняется с помощью ПО AutoGRAPH 7 WEB. Работает как сервис начиная с версий 2015.12.х.
  +
  +
[[File:AGNetService.png|RTENOTITLE]]
   
 
== Минимальные требования к аппаратному и программному обеспечению ==
  
== Минимальные требования к аппаратному и программному обеспечению ==
   
−
*RAM – от 1 GB
 +
*RAM – от 2 GB
−
*Windows 2003 или более новая
 +
*Windows 2008 R2 или более новая
−
*.NET Framework 4.0 или более новый
 +
*.NET Framework 4.6.2 или более новый
−
*установленный загрузчик данных ([[AGDataLoader|AutoGRAPH DataLoader]]) или [[AutoGRAPH Server 5|AutoGRAPH Server 3.x или 4.x или 5.x]]
 +
*установленный загрузчик данных ([[AGDataLoader|AutoGRAPH DataLoader]]) или [[AutoGRAPH_Server_5|AutoGRAPH Server 4.x или 5.x]]
   
 
== Загрузка ==
  
== Загрузка ==
   
  +
Примеры: [http://agi.tk-chel.ru/install/service/AutoGRAPHServiceExamples.zip http://agi.tk-chel.ru/install/service/AutoGRAPHServiceExamples.zip]
−
Последняя версия: 2015.7.18, [[Media:AutoGRAPHNETService20150718.zip|загрузить]]
  
−  
−
== Режим консоли ==
  
−  
−
В основном предназначен для отладки и тестирования. Достаточно просто запустить файл '''AutoGRAPHNETService.exe'''.
  
−  
−
== Режим сервиса ==
  
−  
−
Устанавливается как сервис (служба) Windows и работает автономно. Командная строка для установки:
  
−  
−
<pre>
  
−
sc create AutoGRAPHNETService binPath= "C:\TK\WebMapK\Build-Svc\AutoGRAPHNETService.exe"
  
−
</pre>
  
−  
−
<span class="marker">&nbsp;между binPath= и полным путем - пробел&nbsp;</span>
  
−  
−
== Описание работы ==
  
−  
−
После распаковки AutoGRAPH.NET Service в какой-нибудь каталог необходимо отредактировать файл '''AutoGRAPHNETService.exe.config'''. Далее приведены описания ключей файла конфигурации:
  
−  
−
<pre>
  
−
<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"/>
  
−
</pre>
  
−  
−
{| border="1" cellspacing="0" cellpadding="5" style="width: 100%;"
  
−
|-
  
−
| style="width: 127px;" | key-file
  
−
| style="width: 1145px;" | файл ключа .agkey (от AutoGRAPH.Server), который разрешает использования для прописанного списка приборов. <span class="marker"><span style="background-color:#FFFF00;">Обязательный параметр!</span></span> Без него сервис работать не будет.<br/>
  
−
|-
  
−
| style="width: 127px;" | address
  
−
| style="width: 1145px;" | локальный адрес/точка биндинга в формате url:port, в настоящий момент протестирован только механизм httpBinding.<br/>Ещё один пример точки биндинга - [http://*:80/ http://*:80/] - слушать 80й порт на всех интерфейсах
  
−
|-
  
−
| style="width: 127px;" | address-json
  
−
| style="width: 1145px;" | локальный адрес/точка биндинга в формате url:port для JSON<br/>
  
−
|-
  
−
| style="width: 127px;" | common-directory<br/>
  
−
| style="width: 1145px;" | каталог с общими данными (структура каталога аналогична каталогу [[AutoGRAPH.NET]] – с подкаталогами Schemes, GeoFences, Devices в которых находятся соответствующие файлы схем, геозон, приборов)<br/>
  
−
|-
  
−
| style="width: 127px;" | data-directory<br/>
  
−
| style="width: 1145px;" | каталог данных (=data-каталог) [[AGDataLoader|AutoGRAPH DataLoader]] или [[AutoGRAPH Server 5|AutoGRAPH Server 3.x или 4.x или 5.x]]<br/>
  
−
|}
  
−  
−
После редактирования конфиг-файла можно запустить сервис (или консольно) и сделать запрос:<br/><pre>
  
−
svcutil.exe http://localhost:800/?wsdl /async /tcv:Version35 /ser:DataContractSerializer
  
−
</pre><br/>В данном случае будет создан файл AutoGRAPHSvc.cs с прокси-классом для доступа к WCF-точке сервиса AutGRAPH.NET Service и '''output.config''' файл с описанием параметров подключения WCF. Файл '''output.config''' в данном случае не используется.
  
   
  +
Доступ к тестовому сервису:
−
== Методы сервиса ==
  
   
  +
[http://m.tk-chel.ru/ServiceWCF2.svc http://m.tk-chel.ru/ServiceWCF.svc] (WCF)
−
*[[AutoGRAPH.NET Service EnumSchemas|EnumSchemas]] – получение списка доступных сервису схем
  
−
*[[AutoGRAPH.NET Service EnumDevices|EnumDevices]] – получение списка устройств схемы
  
−
*[[AutoGRAPH.NET Service EnumDrivers|EnumDrivers]] [[File:Tag-new.png]] – получение информации о водителях в схеме
  
−
*[[AutoGRAPH.NET Service EnumGeoFences|EnumGeoFences]] – получение списка геозон схемы
  
−
*[[AutoGRAPH.NET Service GetGeoFences|GetGeoFences]] [[File:Tag-new.png]] – получение информации о геозонах (точки для полигонов и т.д.)
  
−
*[[AutoGRAPH.NET Service GetDevicesInfo|GetDevicesInfo]] – получение информации об устройстве в схеме
  
−
*[[AutoGRAPH.NET Service EnumParameters|EnumParameters]] – получение списка параметров устройства в схеме
  
−
*[[AutoGRAPH.NET Service GetOnlineInfo|GetOnlineInfo]] – получение информации о последнем местоположении устройств
  
−
*[[AutoGRAPH.NET Service GetOnlineInfoAll|GetOnlineInfoAll]] [[File:Tag-new.png]] – получение информации о последнем местоположении всех устройств
  
−
*''GetDataRanges – получение информации о загруженных данных для приборов (минимальная/максимальные доступные даты)''
  
−
*[[AutoGRAPH.NET Service GetTrips|GetTrips]] – получение информации о рейсах устройства с текущими настройками схемы
  
−
*[[AutoGRAPH.NET Service GetTripsCustom|GetTripsCustom]] [[File:Tag-new.png]] – получение информации о рейсах устройства с указанными геозонами&lt;/span&gt;
  
−
*[[AutoGRAPH.NET Service GetStage|GetStage]] [[File:Tag-new.png]] – получение информации по одному отрезку для устройств
  
−
*[[AutoGRAPH.NET Service GetTrack|GetTrack]] – получение трека (даты/время, координаты, скорость) устройства с текущими настройками схемы
  
−
*[[AutoGRAPH.NET Service GetProperties|GetProperties]] – получение списка свойств и их значений устройства
  
−
*[[AutoGRAPH.NET Service GetProperty|GetProperty]] – получение значения одного свойства у списка приборов
  
−
*[[AutoGRAPH.NET Service GetRoute|GetRoute]] – прокладка маршрута и получение этой информации в виде набора точек<span style="color:#A9A9A9;"</span>
  
−
*<span style="color: rgb(169, 169, 169);">''EnumReports&nbsp;- получение списка доступных отчетов''</span>
  
−
*<span style="color:#A9A9A9;">''GetReports - выполнение отчета и загрузка его в виде XML/PDF/DOCX/XLS/.../ZIP-файла (формат выполнения указывается)''</span>
  
−
*<span style="color:#A9A9A9;">''GetReportsAsync - асинхронное выполнение&nbsp;отчета<span style="line-height: 20.7999992370605px;">(ов)</span>''</span>
  
−
*<span style="color:#A9A9A9;">''GetReportsStatus - получение состояния выполнения отчета(ов)''</span>
  
−
*<span style="color:#A9A9A9;">''CancelReports - отмена выполнения отчета''</span>
  
   
  +
[http://m.tk-chel.ru/ServiceJSON http://m.tk-chel.ru/ServiceJSON] (JSON)
−
== Примеры ==
  
   
  +
логин '''demo''' пароль '''demo'''
−
<code><syntaxhighlight lang="csharp">
  
−
using System;
  
−
using System.Collections.Generic;
  
−
using System.Globalization;
  
−
using System.Linq;
  
−
using System.Text;
  
−
using AutoGRAPHService;
  
   
  +
== Режим работы (AutoGRAPH.Web) ==
−
namespace AutoGRAPHSvcTest
  
−
{
  
−
class Program
  
−
{
  
−
static void Main(string[] args)
  
−
{
  
−
var svc = new AutoGRAPHSvcClient(); // создаем прокси-класс с адресом подключения по умолчанию
  
   
  +
Начиная с версий 2015.12.х, AutoGRAPH.Web предоставляет API AutoGRAPH.NET Service по путям:
−
RSchema[] schemas;
  
−
using (var f = new TimeCalc("EnumSchemas")) // запрашиваем список доступных схем
  
−
schemas = svc.EnumSchemas();
  
   
  +
WCF: [http://имя-веб-сервера/ServiceWCF2.svc http://имя-веб-сервера/ServiceWCF2.svc]
−
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);
  
   
  +
1C: [http://имя-веб-сервера/Service1C.asmx http://имя-веб-сервера/Service1C.asmx]
−
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);
 
−
}
  
   
  +
JSON: [http://имя-веб-сервера/ServiceJSON http://имя-веб-сервера/ServiceJSON]&nbsp;- рекомендуется к использованию
−
Console.ReadLine();
  
−
}
  
−
}
  
   
  +
Подробее о механизме аутентификации Login&nbsp;[http://wiki.tk-chel.ru/index.php/AutoGRAPH.NET_Service_Auth здесь].
−
// простой класс для замера скорости выполнения блока
  
−
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)); }
  
−
}
  
−
}
  
−
</syntaxhighlight></code>
  
   
  +
== Работа с сервисом ==
−
<u>Файл .exe.config вышеприведенного примера</u><br/><pre>
  
−
<?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>
  
−
</pre>
  
   
  +
=== [[AutoGRAPH.NET_Service_Methods|Методы сервиса]] ===
−
Данный конфигурационный файл содержит WCF-конфигурацию для точки подключения сервиса. По умолчанию используется HTTP binding, но ровно таким [https://msdn.microsoft.com/en-us/library/ms733027(v=vs.110).aspx же способом]&nbsp;можно включить и [http://wcfsecurity.codeplex.com/wikipage?title=Questions and Answers&referringTitle=Home=Home другие транспорты].
  
   
  +
=== [[AutoGRAPH.NET_Service_Examples|Примеры]] ===
−
== [[AutoGRAPH.NET Service Диагностика неисправностей|Диагностика неисправностей]] ==
  
   
−
Список возможных ошибок и особенностей конфигурации приведён [[AutoGRAPH.NET Service Диагностика неисправностей|здесь]].
 +
=== [[AutoGRAPH.NET_Service_Диагностика_неисправностей|Диагностика неисправностей]] ===

Текущая версия на 15:11, 6 октября 2020

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

RTENOTITLE

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

Загрузка

Примеры: http://agi.tk-chel.ru/install/service/AutoGRAPHServiceExamples.zip

Доступ к тестовому сервису:

http://m.tk-chel.ru/ServiceWCF.svc (WCF)

http://m.tk-chel.ru/ServiceJSON (JSON)

логин demo пароль demo

Режим работы (AutoGRAPH.Web)

Начиная с версий 2015.12.х, AutoGRAPH.Web предоставляет API AutoGRAPH.NET Service по путям:

WCF: http://имя-веб-сервера/ServiceWCF2.svc

1C: http://имя-веб-сервера/Service1C.asmx

JSON: http://имя-веб-сервера/ServiceJSON - рекомендуется к использованию

Подробее о механизме аутентификации Login здесь.

Работа с сервисом

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

Примеры

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

Источник — «http://oldwiki.tk-chel.ru/index.php?title=AutoGRAPH.NET_Service&oldid=56848»