Package sender: сервис-утилита

Сервис предназначен для рассылки документов для ознакомления.

Команды могут приходить как по HTTP, так и через Kafka в топик package_sender_commands.

Сервис разбит на несколько модулей, в виде sbt проектов:

• domain, в котором содержатся все доменные модели и их различные представления.
• commands, в котором содержатся все? что связано с командами, их описанием и обработчиками.
• infrastructure, в котором содержится описание взаимодействия с другими сервисами.
• storage, содержит сервисы для сохранения и чтения их разных хранилищ доменных моделей.
• service, содержит сервисы бизнес логики, которые определяют правила взаимодействия компонентов между собой.
• boot, содержит зависимости и описание для сборки и запуска сервиса.

Информация по добавлению команд можно прочитать в описании шаблона

Локальный запуск

При запуске сервиса ожидается, что уже развернута необходимая инфраструктура:

• PostgreSQL база по адресу localhost:5432/package-sender
• Kafka по адресу localhost:9092
• Consul по адресу localhost:8500
• Адрес Kafka будет указан в application.conf
• Добавлены необходимые переменные окружения:
  • PACKAGE_SENDER_DB_HOST
  • PACKAGE_SENDER_DB_PORT
  • PACKAGE_SENDER_DB_NAME
  • PACKAGE_SENDER_DB_USER
  • PACKAGE_SENDER_DB_PASSWORD

Запуск из консоли с помощью SBT

PACKAGE_SENDER_DB_HOST=localhost PACKAGE_SENDER_DB_PORT=5432 PACKAGE_SENDER_DB_NAME=package-sender PACKAGE_SENDER_DB_USER=postgres PACKAGE_SENDER_DB_PASSWORD=12345 sbt boot/run

Список переменных окружения сервиса Package sender

Все доступные переменные окружения для настройки сервиса.

Список команд сервиса Package sender

В описании команд используется путь/route для отправки команды в сам сервис, а не в ApiGateway. В качестве Input-а для команд, сервис всегда ожидает CommandRequest (как и любой другой сервис, принимающий команды), так что в описании команды указано лишь описание поля payload для CommandRequest.

SendDocumentPackage

Отправить пакет документов.

• Input: SendDocumentPackageInput
• Output: {}

Payload для команды

{
  "documentPackageId": "3d100dbd-d9a4-4ca4-bace-60356991b9d9",
  "isRequired": true,
  "deliveryAt": 1772174531,
  "confirmBefore": "2027-01-27",
  "isEmailNotification": true,
  "additionalEmails": [
    "email@example.com"
  ],
  "individualSearch": {
    "query": "",
    "context": {}
  }
}

Результат выполнения команды

{}

ConfirmDocuments

Подтвердить получение набора документов.

• Input: ConfirmDocumentsInput
• Output: {}

Payload для команды

{
  "sentDocumentPackageId": "3d100dbd-d9a4-4ca4-bace-60356991b9d9",
  "sentDocumentIds": [
    "3d100dbd-d9a4-4ca4-bace-60356991b9d9"
  ]
}

Результат выполнения команды

{}

ListSentDocumentPackages

Список отправленных пакетов документов.

• Input: Search
• Output: Page[GetSentDocumentPackagesOutDTO]

По умолчанию сортировка производится по полю createdAt модели SentDocumentPackage в порядке убывания.

Запрос принимает параметры сортировки, фильтров и пейджинга в параметре Search.

Применяется к полям моделей SentDocumentPackage, DocumentPackage (только по полю data).

Доступные поля для фильтрации и виды фильтров по ним:

Если поле для фильтрации имеет вид data.something, то фильтрация идет по соответствующим полям в data моделей SentDocumentPack age, DocumentPackage.

Доступные поля для сортировки:

Payload для команды

{
  "query": "createdBy",
  "context": {
    "createdBy": "3d100dbd-d9a4-4ca4-bace-60356991b9d9"
  },
  "paging": {
    "page": 1,
    "count": 10
  }
}

Результат выполнения команды

{
  "items": [
    {
      "id": "d7541e37-f0cd-4de5-9752-a11248f4e3de",
      "createdAt": 1710653400000,
      "createdBy": "603ca134-2b65-4dfb-90ea-c592a243b439",
      "title": "title1",
      "data": {
        "test": "1231231",
        "test2": "2222",
        "sent": 231
      },
      "documentPackageId": "2278c676-dbdf-42df-bb5d-8d21c0bf51d8",
      "isRequired": true,
      "isEmailNotification": false,
      "additionalEmails": [
        "email1@test.test",
        "email2@test.test"
      ],
      "deliveryAt": 1736573400000,
      "isDelivered": true,
      "confirmBefore": "2027-01-27",
      "documentCount": 1,
      "userConfirmedCount": 1,
      "userTotalCount": 1
    }
  ],
  "total": 1
}

GetSentDocumentPackage

Получить отправленный пакет документов по id.

• Input: UUID
• Output: GetSentDocumentPackagesOutDTO

Payload для команды

"d7541e37-f0cd-4de5-9752-a11248f4e3de"

Результат выполнения команды

{
  "id": "d7541e37-f0cd-4de5-9752-a11248f4e3de",
  "createdAt": 1710653400000,
  "createdBy": "603ca134-2b65-4dfb-90ea-c592a243b439",
  "title": "title1",
  "data": {
    "test": "1231231",
    "test2": "2222",
    "sent": 231
  },
  "documentPackageId": "2278c676-dbdf-42df-bb5d-8d21c0bf51d8",
  "isRequired": true,
  "isEmailNotification": false,
  "additionalEmails": [
    "email1@test.test",
    "email2@test.test"
  ],
  "deliveryAt": 1736573400000,
  "isDelivered": true,
  "confirmBefore": "2027-01-27",
  "documentCount": 1,
  "userConfirmedCount": 1,
  "userTotalCount": 1
}

ListSentDocumentPackageDocuments

Список документов отправленного пакета.

• Input: ListSentDocumentPackageDocumentsInDTO
• Output: Page[ListSentDocumentPackageDocumentsOutDTO]

Запрос принимает только параметры пейджинга в параметре Search.

Payload для команды

{
  "sentDocumentPackageId": "d7541e37-f0cd-4de5-9752-a11248f4e3de",
  "search": {
    "query": "",
    "context": {},
    "paging": {
      "page": 1,
      "count": 10
    }
  }
}

Результат выполнения команды

{
  "items": [
    {
      "id": "5eb208ec-2e4a-4e03-b22b-0a30ad09f84f",
      "documentId": "869f3d0a-1fe5-4b18-b45e-53d7d8c845de",
      "data": {
        "docField2": "value"
      }
    }
  ],
  "total": 1
}

ListSentDocumentPackageUsers

Список получателей отправленного пакета.

• Input: ListSentDocumentPackageUsersInDTO
• Output: Page[ListSentDocumentPackageUsersOutDTO]

Запрос принимает только параметры пейджинга в параметре Search.

Payload для команды

{
  "sentDocumentPackageId": "d7541e37-f0cd-4de5-9752-a11248f4e3de",
  "search": {
    "query": "",
    "context": {},
    "paging": {
      "page": 1,
      "count": 10
    }
  }
}

Результат выполнения команды

{
  "items": [
    {
      "id": "deb056ea-1264-4c27-b135-4a8d7e43ecfc",
      "email": "employee@email.ru",
      "userId": "a05539ac-e7a0-4c92-bf5b-caabfa3fe884",
      "individualId": "deb056ea-1264-4c27-b135-4a8d7e43ecfc",
      "title": "employee",
      "lastNotification": 1715922660000,
      "documentConfirmedCount": 1,
      "documentTotalCount": 1
    }
  ],
  "total": 1
}

ListUserDocuments

Список документов отправленного пакета по получателю.

• Input: ListUserDocumentsInDTO
• Output: Page[ListUserDocumentsOutDTO]

Запрос принимает только параметры пейджинга в параметре Search.

Payload для команды

{
  "sentDocumentPackageUserId": "819a2735-ac55-4a14-8225-5b4d84645f9b",
  "search": {
    "query": "",
    "context": {},
    "paging": {
      "page": 1,
      "count": 10
    }
  }
}

Результат выполнения команды

{
  "items": [
    {
      "sentDocumentId": "5eb208ec-2e4a-4e03-b22b-0a30ad09f84f",
      "documentId": "869f3d0a-1fe5-4b18-b45e-53d7d8c845de",
      "isConfirmed": true,
      "data": {
        "docField2": "value"
      },
      "confirmedAt": 1715922660000
    }
  ],
  "total": 1
}

ListUserSentDocumentPackages

Список отправленных текущему пользователю пакетов документов.

• Input: Search
• Output: Page[ListUserSentDocumentPackagesOutDTO]

По умолчанию сортировка производится по полю createdAt модели SentDocumentPackage в порядке убывания.

Запрос принимает параметры сортировки, фильтров и пейджинга в параметре Search.

Применяется к полям моделей SentDocumentPackage, DocumentPackage (только по полю data).

Доступные поля для фильтрации и виды фильтров по ним:

Если поле для фильтрации имеет вид data.something, то фильтрация идет по соответствующим полям в data моделей SentDocumentPack age, DocumentPackage.

Доступные поля для сортировки:

Payload для команды

{
  "query": "createdBy",
  "context": {
    "createdBy": "3d100dbd-d9a4-4ca4-bace-60356991b9d9"
  },
  "paging": {
    "page": 1,
    "count": 10
  }
}

Результат выполнения команды

{
  "items": [
    {
      "id": "d7541e37-f0cd-4de5-9752-a11248f4e3de",
      "createdAt": 1710653400000,
      "createdBy": "603ca134-2b65-4dfb-90ea-c592a243b439",
      "data": {
        "test": "1231231",
        "test2": "2222",
        "sent": 231
      },
      "documentPackageId": "2278c676-dbdf-42df-bb5d-8d21c0bf51d8",
      "isRequired": true,
      "isEmailNotification": false,
      "additionalEmails": [
        "email1@test.test",
        "email2@test.test"
      ],
      "deliveryAt": 1736573400000,
      "isDelivered": true,
      "confirmBefore": "2027-01-08",
      "documentCount": 1,
      "isConfirmed": true
    }
  ],
  "total": 1
}

ResendUsersNotifications

Отправка уведомления пользователю о необходимости ознакомления с пакетом.

• Input: ResendUserNotificationsInput
• Output: {}

Payload для команды

{
  "sentDocumentPackageId": "3d100dbd-d9a4-4ca4-bace-60356991b9d9",
  "sentDocumentPackageUserIds": [
    "3d100dbd-d9a4-4ca4-bace-60356991b9d9"
  ]
}

Результат выполнения команды

{}

ResendDocumentPackagesNotifications

Отправка уведомления пользователям о необходимости ознакомления с пакетом.

• Input: List SentDocumentPackageId
• Output: {}

Payload для команды

[
  "3d100dbd-d9a4-4ca4-bace-60356991b9d9"
]

Результат выполнения команды

{}

Модели сервиса package-sender

SendDocumentPackageInput

ConfirmDocumentsInput

GetSentDocumentPackagesOutDTO

ListSentDocumentPackageDocumentsInDTO

ListSentDocumentPackageDocumentsOutDTO

ListSentDocumentPackageUsersInDTO

ListSentDocumentPackageUsersOutDTO

ListUserDocumentsInDTO

ListUserDocumentsOutDTO

ListUserSentDocumentPackagesOutDTO

ResendUserNotificationsInput

SAP-po-integration: сервис для интеграции с шиной данных полюса sap-po

Сервис получает НМД из СЭД.
Команды могут приходить как по HTTP, так и через Kafka в топик sap_po_integration_commands.

Сервис разбит на несколько модулей, в виде sbt проектов:

• domain, в котором содержатся все доменные модели и их различные представления.
• commands, в котором содержатся все? что связано с командами, их описанием и обработчиками.
• infrastructure, в котором содержится описание взаимодействия с другими сервисами.
• storage, содержит сервисы для сохранения и чтения их разных хранилищ доменных моделей.
• service, содержит сервисы бизнес логики, которые определяют правила взаимодействия компонентов между собой.
• boot, содержит зависимости и описание для сборки и запуска сервиса.

Информация по добавлению команд можно прочитать в описании шаблона

Локальный запуск

При запуске сервиса ожидается, что уже развернута необходимая инфраструктура:

• PostgreSQL база по адресу localhost:5432/sap-po-integration
• Kafka по адресу localhost:9092
• Consul по адресу localhost:8500
• Адрес Kafka будет указан в application.conf
• Добавлены необходимые переменные окружения:
  • SAP_PO_INTEGRATION_DB_HOST
  • SAP_PO_INTEGRATION_DB_PORT
  • SAP_PO_INTEGRATION_DB_NAME
  • SAP_PO_INTEGRATION_DB_USER
  • SAP_PO_INTEGRATION_DB_PASSWORD

Запуск из консоли с помощью SBT

SAP_PO_INTEGRATION_DB_HOST=localhost SAP_PO_INTEGRATION_DB_PORT=5432 SAP_PO_INTEGRATION_DB_NAME=sap-po-integration SAP_PO_INTEGRATION_DB_USER=postgres SAP_PO_INTEGRATION_DB_PASSWORD=12345 sbt boot/run

Список переменных окружения сервиса SAP-po-integration

Все доступные переменные окружения для настройки сервиса.

Список команд сервиса SAP-po-integration

В описании команд используется путь/route для отправки команды в сам сервис, а не в ApiGateway. В качестве Input-а для команд, сервис всегда ожидает CommandRequest (как и любой другой сервис, принимающий команды), так что в описании команды указано лишь описание поля payload для CommandRequest.

В сервисе реализованы команды:

• СЭД - Обработать поток данных MasterNmds
• СЭД - Обработать поток данных Nmds
• СЭД - Скачать файл НМД
• АСУП - Обработать поток данных Departments
• АСУП - Обработать поток данных FunctionBlocks
• АСУП - Обработать поток данных Organizations
• АСУП - Обработать поток данных Persons
• АСУП - Обработать поток данных StaffPositions
• СПД - Обработать поток данных Category
• СПД - Обработать поток данных Family
• СПД - Обработать поток данных Function
• СПД - Обработать поток данных ManagementVertical
• СПД - Обработать поток данных Profile
• СПД - Обработать поток данных SubFamily
• СПД - Обработать поток данных Task
• КСУ НСИ - Обработать поток данных BusinessGlossary
• КСУ НСИ - Обработать поток данных InformationalSystem
• КСУ НСИ - Обработать поток данных ProcessModel
• КСУ НСИ - Обработать поток данных ISCondition

MasterNmdHandle

Принимает поток из главных NMD сущностей, имеют первый приоритет.

• Input: MasterNmdHandleRequest
• Output: SavedResponse

Payload для команды

{
  "masterNMD": [
    {
      "guid": "00001111-2222-3333-4444-555566667777",
      "<MasterNmdField1>": "..."
    }
  ]
}

Результат выполнения команды

{
  "saved": 1
}

RegistryNmdHandle

Принимает поток из NMD сущностей.

• Input: RegistryNmdHandleRequest
• Output: SavedResponse

Payload для команды

{
  "registerNMD": [
    {
      "guid": "00001111-2222-3333-4444-555566667777",
      "<NmdField1>": "..."
    }
  ]
}

Результат выполнения команды

{
  "saved": 1
}

NmdFileHandle

Получить файл по ID

• Input: UUID
• Output: FileAttachment

Payload для команды

"c943f0e9-a744-46b9-94f7-79709542fba4"

Результат выполнения команды

{
  "fileGuid": "c943f0e9-a744-46b9-94f7-79709542fba4",
  "fileData": "data",
  "fileName": "name",
  "fileHideFromListFiles": false,
  "typeFile": "type",
  "typeFileGuid": "c943f0e9-a744-46b9-94f7-79709542fba4",
  "extension": "md"
}

DepartmentRawHandle

Принимает поток данных подразделений из АСУП.

• Input: DepartmentData[]
• Output: SavedResponse

Payload для команды

[
  {
    "guid": "00001111-2222-3333-4444-555566667777",
    "<DepartmentField>": "..."
  }
]

Результат выполнения команды

{
  "saved": 1
}

FunctionBlockRawHandle

Принимает поток данных функциональных блоков из АСУП.

• Input: FunctionBlockData
• Output: SavedResponse

Payload для команды

[
  {
    "guid": "00001111-2222-3333-4444-555566667777",
    "<FunctionBlockField>": "..."
  }
]

Результат выполнения команды

{
  "saved": 1
}

OrganizationRawHandle

Принимает поток данных организаций из АСУП.

• Input: OrganizationData[]
• Output: SavedResponse

Payload для команды

[
  {
    "guid": "00001111-2222-3333-4444-555566667777",
    "<OrganizationField>": "..."
  }
]

Результат выполнения команды

{
  "saved": 1
}

PersonRawHandle

Принимает поток данных сотрудников из АСУП.

• Input: PersonData[]
• Output: SavedResponse

Payload для команды

[
  {
    "guid": "00001111-2222-3333-4444-555566667777",
    "<PersonField>": "..."
  }
]

Результат выполнения команды

{
  "saved": 1
}

StaffPositionRawHandle

Принимает поток данных штатное расписание из АСУП.

• Input: StaffPositionData
• Output: SavedResponse

Payload для команды

[
  {
    "guid": "00001111-2222-3333-4444-555566667777",
    "<StaffPositionField>": "..."
  }
]

Результат выполнения команды

{
  "saved": 1
}

CategoryRawHandle

Принимает поток данных Category из СПД.

• Input: CategoryData[]
• Output: SavedResponse

Payload для команды

[
  {
    "categoryGuid": "00001111-2222-3333-4444-555566667777",
    "<Field>": "..."
  }
]

Результат выполнения команды

{
  "saved": 1
}

FamilyRawHandle

Принимает поток данных Family из СПД.

• Input: FamilyData[]
• Output: SavedResponse

Payload для команды

[
  {
    "familyGuid": "00001111-2222-3333-4444-555566667777",
    "<Field>": "..."
  }
]

Результат выполнения команды

{
  "saved": 1
}

FunctionRawHandle

Принимает поток данных Function из СПД.

• Input: FunctionData[]
• Output: SavedResponse

Payload для команды

[
  {
    "functionGuid": "00001111-2222-3333-4444-555566667777",
    "<Field>": "..."
  }
]

Результат выполнения команды

{
  "saved": 1
}

ManagementVerticalRawHandle

Принимает поток данных ManagementVertical из СПД.

• Input: ManagementVerticalData[]
• Output: SavedResponse

Payload для команды

[
  {
    "managementVerticalGuid": "00001111-2222-3333-4444-555566667777",
    "<Field>": "..."
  }
]

Результат выполнения команды

{
  "saved": 1
}

ProfileRawHandle

Принимает поток данных Profile из СПД.

• Input: ProfileData[]
• Output: SavedResponse

Payload для команды

[
  {
    "guid": "00001111-2222-3333-4444-555566667777",
    "<Field>": "..."
  }
]

Результат выполнения команды

{
  "saved": 1
}

SubFamilyRawHandle

Принимает поток данных SubFamily из СПД.

• Input: SubFamilyData[]
• Output: SavedResponse

Payload для команды

[
  {
    "subfamilyGuid": "00001111-2222-3333-4444-555566667777",
    "<Field>": "..."
  }
]

Результат выполнения команды

{
  "saved": 1
}

TaskRawHandle

Принимает поток данных Task из СПД.

• Input: TaskData[]
• Output: SavedResponse

Payload для команды

[
  {
    "taskGuid": "00001111-2222-3333-4444-555566667777",
    "<Field>": "..."
  }
]

Результат выполнения команды

{
  "saved": 1
}

BusinessGlossaryRawHandle

Принимает поток данных бизнес-глоссария из КСУ НСИ.

• Input: BusinessGlossaryData
• Output: SavedResponse

Payload для команды

{
  "guid": "00001111-2222-3333-4444-555566667777",
  "<Field>": "..."
}

Результат выполнения команды

{
  "saved": 1
}

InformationalSystemRawHandle

Принимает поток данных информационных систем из КСУ НСИ.

• Input: InformationalSystemData[]
• Output: SavedResponse

Payload для команды

[
  {
    "guid": "00001111-2222-3333-4444-555566667777",
    "<Field>": "..."
  }
]

Результат выполнения команды

{
  "saved": 1
}

ProcessModelRawHandle

Принимает поток данных процессной модели из КСУ НСИ.

• Input: ProcessModelData
• Output: SavedResponse

Payload для команды

{
  "guid": "00001111-2222-3333-4444-555566667777",
  "<Field>": "..."
}

Результат выполнения команды

{
  "saved": 1
}

ISConditionRawHandle

Принимает поток данных состояний информационных систем из КСУ НСИ.

• Input: ISConditionData
• Output: SavedResponse

Payload для команды

{
  "guid": "00001111-2222-3333-4444-555566667777",
  "<Field>": "..."
}

Результат выполнения команды

{
  "saved": 1
}

MasterNmdHandleRequest

MasterNmdData

RegistryNmdHandleRequest

RegistryNmdData

FileAttachment

DepartmentData

OrganizationData

StaffPositionData

PersonData

FunctionBlockData

CategoryData

FamilyData

FunctionData

ManagementVerticalData

ProfileData

SubFamilyData

TaskData

BusinessGlossaryData

InformationalSystemData

ProcessModelData

ISConditionData

SavedResponse

SOPR-control: сервис-утилита

Сервис содержит в себе мигратор для сущностей в другие сервисы. А также обработчик событий EntityObjectEvent. Команд пока нет, но возможность обработки предусмотрена. Команды могут приходить как по HTTP, так и через Kafka в топик sopr_control_commands.

Сервис разбит на несколько модулей, в виде sbt проектов:

• domain, в котором содержатся все доменные модели и их различные представления.
• commands, в котором содержатся все? что связано с командами, их описанием и обработчиками.
• infrastructure, в котором содержится описание взаимодействия с другими сервисами.
• storage, содержит сервисы для сохранения и чтения их разных хранилищ доменных моделей.
• service, содержит сервисы бизнес логики, которые определяют правила взаимодействия компонентов между собой.
• boot, содержит зависимости и описание для сборки и запуска сервиса.

Информация по добавлению команд можно прочитать в описании шаблона

Локальный запуск

При запуске сервиса ожидается, что уже развернута необходимая инфраструктура:

• PostgreSQL база по адресу localhost:5432/sopr-control
• Kafka по адресу localhost:9092
• Consul по адресу localhost:8500
• Адрес Kafka будет указан в application.conf
• Добавлены необходимые переменные окружения:
  • SOPR_CONTROL_DB_HOST
  • SOPR_CONTROL_DB_PORT
  • SOPR_CONTROL_DB_NAME
  • SOPR_CONTROL_DB_USER
  • SOPR_CONTROL_DB_PASSWORD

Запуск из консоли с помощью SBT

SOPR_CONTROL_DB_HOST=localhost SOPR_CONTROL_DB_PORT=5432 SOPR_CONTROL_DB_NAME=sopr-control SOPR_CONTROL_DB_USER=postgres SOPR_CONTROL_DB_PASSWORD=12345 sbt boot/run

Список переменных окружения сервиса SOPR-control

Все доступные переменные окружения для настройки сервиса.

Список команд сервиса SOPR-control

В описании команд используется путь/route для отправки команды в сам сервис, а не в ApiGateway. В качестве Input-а для команд, сервис всегда ожидает CommandRequest (как и любой другой сервис, принимающий команды), так что в описании команды указано лишь описание поля payload для CommandRequest.

GenerateUiForms

Генерация визуальных форм.

• Input: GenerateUiFormsInput
• Output: {}

Payload для команды

{
  "entityTypeId": "InformationalSystem",
  "formCodes": [
    "card",
    "createForm",
    "editForm",
    "list",
    "filterPanel"
  ]
}

Результат выполнения команды

{}

Модели сервиса sopr-control

GenerateUiFormsInput

FormCode

Возможные значения:

• card - Карточка объекта
• createForm - Форма создания
• editForm - Форма редактирования
• list - Реестр
• filterPanel - Панель фильтров в реестре