Сведения о системе
Шлюз обеспечивает интеграцию данных между линейкой продуктов V5 и другими решениями. Шлюз может как производить, так и получать данные.
Шлюз отличается высокой гибкостью, обеспечивая быстрое развертывание с множеством различных ERP и внешних систем, что позволяет вам эффективно интегрировать всю фабрику.
Этот документ служит подробным обзором того, как использовать различные методы для импорта и экспорта данных. Он также подробно описывает каждую сущность, которую можно импортировать, и возможные поля для этих сущностей.
Доступ к шлюзу можно получить через REST API веб-интерфейса, использующий JSON или XML, или через прямой обмен файлами с документами CSV или XML.
API V5 предоставляет доступ к различным методам импорта и экспорта.
Импорт осуществляется модулем IntegrationImport. Экспорт осуществляется модулем IntegrationExport.
Вы можете получить доступ к этим модулям из проводника пакетов, где вы можете увидеть доступные методы интеграции.
Описание каждого метода содержит тег, который указывает, является ли это запросом GET или POST, а также URI для данного метода.
Рекомендуется сначала протестировать соединение с помощью клиента REST.
После установки V5-API в качестве веб-службы (см. Примечания по установке) вы можете получить доступ к этим конечным точкам через браузер или клиент REST по адресу:
http://{hostname:port}/{V5-API}/api
Модуль IntegrationImport имеет путь /integrate/import/
Модуль IntegrationExport имеет путь /integrate/export/
Вы можете получить номер версии, выполнив запрос /integrate/version/
Каждый метод имеет свой собственный путь, указанный в этом документе как URI, который можно добавить к указанным выше путям для выполнения метода.
Путь для getUsers() is /users. Пример получения списка пользователей:
http://localhost:8080/V5-API/api/integrate/export/users
Если шлюз настроен правильно, вы должны получить список пользователей, зарегистрированных в системе. Если что-то пошло не так, вам будет предоставлен код ответа и причина.
Список, который вы получите, будет в формате JSON. Вам также понадобится POST в формате JSON. Все поля и объекты определены в пакете базы данных, который вы можете найти в этом документе через проводник пакетов.
На нашем веб-сайте представлена дополнительная информация о системе. Для получения последней документации и руководств посетите нас по адресу www.sgsystemsglobal.com.
Импортировать
Файлы можно импортировать двумя способами.
Вы можете выбрать файл для использования, щелкнув правой кнопкой мыши значок на панели задач Центра управления и выбрав Шлюз, затем Импортировать файл, или вы можете поместить файлы в
gateway/import каталог.Это подход, который следует использовать, если вы регулярно выполняете импорт. Шлюз будет обрабатывать файлы в том порядке, в котором они поступают в каталог.
Структура:
Импортируемые файлы должны соответствовать структуре, определенной в папке column_defs. Заголовочные файлы имеют формат `.csvh` и могут быть открыты любым текстовым редактором.
Вы можете импортировать различные сущности в базу данных, такие как товары или строки заказов на продажу. Каждая сущность имеет ряд полей, которые определяют объект. Некоторые поля являются обязательными, а другие — необязательными.
Список возможных значений см. В пакете базы данных.
Соглашение об именовании
Имена файлов должны содержать соответствующее имя файла заголовка в папке column_defs. Имя типа объекта должно начинаться с имени файла и добавляться тире (-).
Например, заголовочный файл Clients называется «client», поэтому допустимым именем файла будет
client-123.csv.Если файл уже был импортирован ранее и все еще существует в папках каталога шлюза, он будет перезаписан при последующем импорте.
Связывание сущностей
Сущности могут быть связаны при импорте файлов, чтобы обеспечить большую эффективность и позволить использовать меньшее количество файлов в каждом процессе.
Если существует ссылка, можно определить несколько объектов в одном файле. Например, при импорте строки заказа на продажу вы также можете одновременно указать информацию о заказе на продажу, и шлюз будет динамически ее генерировать для вас.
Вы можете отключить возможность шлюза динамически создавать внутренние сущности из панели настроек в центре управления в разделе «Вставить дочерние сущности». Он по-прежнему будет искать уже существующие ссылки, но не будет их создавать.
При указании объекта в ссылке можно использовать подчеркивание `_` в определении столбца. Например, на код формулы можно ссылаться как
Formula_Commodity_Code.Уровни валидации импорта
Все данные, импортированные в систему V5, будут проверены для защиты системы. Проверка может быть установлена на разных уровнях строгости.
- ВНИМАНИЕ: Если в файле обнаружена ошибка и импорт строки невозможен, система уведомит вас об этом, но продолжит обработку оставшейся части файла.
- ОТМЕНА: Если в файле обнаружена ошибка и импорт строки невозможен, система прервет процесс и сообщит вам об ошибке.
Экспортировать
Включение экспорта позволит помещать данные в файлы формата CSV в каталоге экспорта.
Экспорт может быть выполнен по требованию или при изменении, импорте или создании данных. Каждая таблица в системе имеет значок экспорта, который можно нажать для создания файла, содержащего данные, видимые в активной таблице.
Чтобы включить регулярный экспорт, установите интервал экспорта больше нуля и выберите, какие объекты вы хотите экспортировать.
Структура:
У каждой сущности есть свой собственный формат экспорта по умолчанию. Он отображает все публичные данные об объекте и любые ключевые данные из связанных сущностей.
Используя файлы `.csvh` в папке export/order, вы можете указать, какие данные следует включить, а также их порядок.
Соглашения об именах такие же, как и для файлов импорта, и перечислены в пакете базы данных. Как и при импорте, можно экспортировать несколько связанных объектов в одном файле.
Вы можете указать, следует ли включать данные заголовка в файл экспорта, используя флажок «Экспорт заголовков».
На нашем веб-сайте представлена дополнительная информация о системе. Для получения последней документации и руководств посетите нас по адресу www.sgsystemsglobal.com.
| Упаковка | Описание |
|---|---|
| com.sgapi.config |
Этот пакет управляет конфигурацией SG-API. Конфигурация устанавливается после запуска службы, но может быть изменена для настройки поведения некоторых алгоритмов. После изменения конфигурации требуется перезагрузка.
|
| com.sgapi.resources |
Этот пакет предоставляет ресурсы, специфичные для API, которые используются для определенных передач данных, доступных через конечные точки.
|
| com.sgapi.services |
Этот пакет предоставляет конечные точки для интеграции данных с системой SG V5. Импорт обрабатывается в классе IntegrationImport. Экспорт обрабатывается в классе IntegrationExport.
|
| com.sgs.common.database |
Этот пакет отвечает за хранение всех объектов, которые могут сохраняться в системе SG V5.
|