Установка Documents Generation API

Для установки Documents Generation API требуется скопировать его файлы в целевую папку. Для этого нужно выполнить команду:

Copy-Item ".\TerraLink.xDEPro\DocumentsGeneration.REST" -Destination "$($env:ProgramFiles)\TerraLink.xDEPro\DocumentsGeneration\DocumentsGeneration.REST" -Recurse

Настройка подключения к базе данных

Теперь нужно настроить подключение Documents Generation API к базе данных. Для этого требуется переименовать демонстрационный конфигурационный файл с шаблоном подключения к SQL Server в конфигурационный файл, который будет использоваться Documents Generation API:

Rename-Item -Path "$($env:ProgramFiles)\TerraLink.xDEPro\DocumentsGeneration\DocumentsGeneration.REST\appsettings.SqlServer.DocumentsGeneration.json.demo" -NewName "appsettings.json"

Далее нужно открыть конфигурационный файл в текстовом редакторе:

notepad "$($env:ProgramFiles)\TerraLink.xDEPro\DocumentsGeneration\DocumentsGeneration.REST\appsettings.json"

найти поле ConnectionString, заменить имя экземпляра SQL Server и задать имя пользователя и пароль назначенной учетной записи:

{
    "ProviderName": "Microsoft.Data.SqlClient",
    "ConnectionString": "Server=.\\SQLEXPRESS;Database=XML_GENERATION_DB;User Id=sa;Password=1234aA;MultipleActiveResultSets=true;Max Pool Size=500;TrustServerCertificate=True"
}

Затем нужно сохранить файл (Ctrl+S) и выйти из редактора.

Примечание

Если планируется использовать SQL Server, установленный на другой машине, то в строке подключения нужно указать имя хоста (либо IP-адрес) и порт установленного экземпляра SQL Server.

Настройка подключения к Authentication API

Для работы Documents Generation API понадобится подключение к Authentication API.

Для настройки подключения нужно открыть конфигурационный файл appsettings.json в текстовом редакторе и задать строку подключения в поле AuthenticationApiConnectAddress, указав имя или IP-адрес хоста и порт для подключения к Authentication API через IIS:

"AuthenticationApiConnectAddress": "http://192.168.11.128:6133",

Настройка доступа к Documents Generation API через IIS

Для настройки доступа к Documents Generation API через IIS требуется открыть приложение IIS Manager.

Создание пула приложений

В IIS Manager выбрать элемент «Application Pools» и в его контекстном меню выбрать команду «Add Application Pool…»:

Затем нужно задать параметры пула:

• Name: xde-documents_generation-api

• .NET CLR Version: No Managed Code

Остальные параметры оставить без изменений и нажать кнопку OK:

Теперь нужно задать учетную запись для работы пула приложений. Для этого выбрать пул в списке и справа на панели «Actions» выбрать действие «Advanced Settings…»:

В окне «Advanced Settings» нужно найти настройку «Identity» и нажать кнопку ...:

В окне «Application Pool Identity» выбрать «Custom account» и нажать кнопку Set...:

В окне «Set Credentials» задать имя пользователя, от имени которого ведется установка Продукта, его пароль, и подтвердить пароль. После этого нажать кнопку OK:

Затем нажать кнопку OK в окне «Application Pool Identity» и в окне «Advanced Settings».

Создание сайта

В IIS Manager выбрать элемент «Sites» и в его контекстном меню выбрать команду «Add Website…»:

Затем нужно задать параметры сайта:

• Site name: xde-documents_generation-api

• Application pool: xde-documents_generation-api

• Physical path: C:\Program Files\TerraLink.xDEPro\DocumentsGeneration\DocumentsGeneration.REST

• Port: 6140

Остальные параметры оставить без изменений и нажать кнопку OK:

Добавление правила в настройки Firewall

Для того чтобы Documents Generation API был доступен снаружи, в настройки Firewall нужно добавить правило, открывающее порт созданного сайта. Для этого в строке поиска нужно набрать текст «advanced security» и в результатах поиска выбрать приложение «Windows Defender Firewall with Advanced Security»:

В окне приложения выбрать элемент «Inbound Rules» и в его контекстном меню выбрать команду «New Rule…»:

Тип правила установить в значение Port и нажать кнопку Next:

Далее нужно указать значение порта для созданного сайта и нажать кнопку Next:

Далее нужно разрешить подключение и нажать кнопку Next:

Далее выбрать типы сетей, из которых разрешено подключение (по умолчанию подключение разрешено из всех), и нажать кнопку Next:

Далее нужно задать имя для правила и нажать кнопку Finish:

Проверка доступности Documents Generation API

Для проверки доступности Documents Generation API нужно открыть браузер на машине, отличной от той, на которую производится установка. В адресной строке браузера указать имя или IP-адрес целевой машины и порт:

http://192.168.11.128:6140

В ответ в браузере должна открыться страница Swagger UI.