Page History

The MID server infrastructure agent is an PHP application that can be run as a Windows service intended for facilitating in order to facilitate communication and task handling between SimpleOne instance and external systems.Отсутствие документации, описания и схемы архитектурного решения, схемы взаимодействия с инстансом и инфраструктурой клиента, требований к ресурсам и публичной ссылки на скачивание самого MID сервера.

Concepts

Концепция MID заключается во взаимодействии между системой SimpleOne и внешними сервисами (например, серверами LDAP или почтовыми сервисами) со следующими целями:

• синхронизация информации в системе SimpleOne по заранее заданным шаблонам.
• синхронизация информации в сторонних системах по заранее заданным шаблонам.

Взаимодействие производится с помощью PHP-приложения, запускающегося в среде Windows. Для запуска необходимы интерпретатор PHP версии не менее 7.2 и curl. Принципиальная схема взаимодействия показана ниже

Image Removed

Как должно происходить взаимодействие:

1. На инстансе SimpleOne устанавливается MID-сервер
2. На вин-сервере во внешней инфраструктуре устанавливается MID-агент
3. Агент отправляет запрос к серверу для получения задания (задания настраиваются пауэршел-скриптами в мид скрипт). Периодичность запросов задается планировщиком Windows
   1. Если правила файрвола не позволяют соединиться с сервером, то агент не сможет получить задания.
4. При наличии заданий агент их выполняет, передает серверу сообщение об успешном или неуспешном выполнении.

Требования к ресурсам / System requirements

Как таковых требований к системным ресурсам у агента нет. Он устанавливается на сервере windows, соответственно, системные требования ограничены требованиями к серверу windows. Потребление ресурсов агентом минимально. Агент требует установленный интерпретатор пхп 7.2 (не меньше) и курл.

Требования к системным ресурсам сервера: устанавливается на инстансе симпла, много тоже не требует. Как и агент, требует пхп 7.2 минимум и курл.

To set up and configure your MID server, you'll need to have:

1. A SimpleOne instance deployed in a cloud;
2. An external Windows server with PHP 7.2 and CURL installed.

To configure your MID server, you need to find the .env configuration file in the \bin directory where the MID server was installed. Copy your *.env.example file into the *.env one and modify it in appropriate with your instance settings.

Example of the configuration file:

MID_API_USERNAME=admin

MID_API_PASSWORD=123456

MID_API_SERVERID=157237947616342741

MID_API_ENDPOINT=http://simple.test/rest

MID Server configuration file description

In SimpleOne, communication among the instance and customer infrastructure (for example, LDAP servers or mail servers) is implemented using the "server-agent" technology.

It is used for collaboration when integration with customer software is needed. Main aims of this collaboration are:

1. Information synchronization on SimpleOne instance with predefined templates.
2. Information synchronization on customer instances with predefined templates.

System Requirements

Either server or agent have been developed as a very lightweight applications and do not require many system resources, such as CPU, RAM or hard disk space.

Software requirements

Interaction procedure

Interaction configuring, if simplified, can be represented as described below:

1. Install infrastructure agent on Microsoft Windows server in a customer infrastructure.
2. Configure infrastructure server on SimpleOne instance.
3. Configure tasks for infrastructure agent.
4. After that, the interaction begins.
5. Agent sends requests to server to get a job assignment. Request interval can be configured via Windows Task Scheduler (generally, it is 1 minute).
   1. If there are no tasks to run, the agent performs further attempts within the intervals configured.
   2. If there are any tasks to run, the agent starts executing them in turn.
      1. Whether tasks were completed successfully or not, the agent will connect to the server to report execution.

You can find graphical principles of this process on the diagram below:

Image Added

Anchor
Infrastructure server Infrastructure server

Setting up infrastructure

server

Please complete the steps below to add the server parameters into the appropriate table:

1. Navigate to MID servers → MID server.
2. Click New and fill in the form.
3. Click Save or Save and Exit to apply changes.

MID Server form fields

Configuring infrastructure agent

To configure your infrastructure agent, you need to find the .env configuration file in the \bin directory where the infrastructure agent was installed. Copy your *.env.example file into the *.env one and modify it in appropriate with your instance settings.

Example of the configuration file:

MID_API_USERNAME=admin

MID_API_PASSWORD=123456

MID_API_SERVERID=157237947616342741

MID_API_ENDPOINT=https://instance.example.com/rest

Infrastructure Server configuration file description

Adding scripts

After you set up your MID serveryour infrastructure agent, you need to configure the PowerShell scripts for it. 

1. Navigate to MID Servers → MID scriptScripts.
2. Click New and fill in the form.
3. Click Save or Save and Exit to apply changes.

MID Script form fields

$title='Title:\n';Write-Host($title);Write-Host($param1);

{"param1":"String value"}

Title:
String value

Anchor
Tasks Tasks

Setting up a task

To set up a job on the external infrastructure element, you need to create a record in the MID Queue (sys_mid_queue) table. For this, please complete the steps below.

1. Navigate to MID Servers → MID Queue.
2. Click New and fill in the form.
3. Click Save or Save and Exit to apply changes.

MID Queue form fields

php.exe bin\agent mid:run-job