Функциональная спецификация на разработку интерфейса в SAP PI
Ниже представлен пример (образец) проектного документа спецификации на разработку интерфейса передачи данных в SAP PI.
Данный документ формируется IT-специалистом на этапе проектирования интерфейсов интеграции (обмена данными).
Интерфейс передачи данных <Код интерфейса 1>
| Назначение интерфейса 2 | |
| Функциональное направление 3 | |
| Бизнес-процесс 4 | |
| Наименование 5 | |
| Определение интерфейса | ( ) Синхронный ( ) Асинхронный |
| Направление интерфейса | ( ) Получение ( ) Передача ( ) Двусторонний |
| Частота обмена данными через интерфейс | ( ) Ежедневно ( ) Еженедельно ( ) Ежемесячно ( ) 1р. в 2 недели ( ) В реальном времени ( ) Другая: |
| Интервал времени 6 | |
| Тип | ( ) IDoc ( ) RFC ( ) XI ( ) JDBC ( ) JMS ( ) File ( ) HTTP ( ) SOAP ( ) Marketplace ( ) RNIF ( ) Другой: |
| Дополнительное описание интерфейса 7 |
1 Кодирование интерфейса передачи данных производится по следующему правилу:
| Синтаксис | |
|---|---|
| Message interface | MI_OUT|IN_<Num MI Out>_<SYNC|ASYNC|ABS> |
| Глоссарий | |
| <Num MI Out> | Уникальный порядковый трехзначный номер интерфейса выгрузки данных |
| <SYNC|ASYNC> | SYNC – синхронный; ASYNC - асинхронный |
2 Приводится краткое описание для выгрузки каких данных предназначен интерфейс и из какой системы.
3 Функциональное направление в рамках которого реализуется интерфейс.
4 Бизнес-процесс(ы) в рамках которых будет использоваться данный интерфейс.
5 Название интерфейса на русском языке отражающее суть данных передающихся через данный интерфейс.
6 Указывается интервал времени в период которого осуществляется выгрузка данных в интерфейс.
7 Например: «Выгрузка данных может осуществляться в двух режимах: режиме полной выгрузки данных и режиме выгрузки изменений. Режим полной выгрузки данных предполагает выгрузку данных всех объектов из системы источника. Режим выгрузки изменений предполагает выгрузку данных всех объектов из системы источника после заданной даты».
Структура данных интерфейса передачи данных
Структура входных данных (Request)
| Наименование структуры данных | <Код в PI> 1 | ||||
|---|---|---|---|---|---|
| Уровень2 | Наименование поля | Наименование объекта / данных | Тип данных3 | Наличие4 | Комментарий |
1 Кодирование производится по следующему правилу:
| Синтаксис | |
|---|---|
| Message Type | MT_ <Num System>_RQS_<Num Data Type> |
| Глоссарий | |
| <Num System> | Уникальный порядковый двухзначный номер бизнес-системы (см. описание систем) |
| <Num Data Type> https://pharmaciev....a/ | Уникальный порядковый трехзначный номер |
Например, MT_01_RQS_004
2 Иерархия уровней вложенности в SAP PI.
3 Тип данных. Например, String.
4 Обязательность поля в сообщении. 0 – поле не обязательное, встречается один раз; 1- поле обязательное, встречается один раз. Значение для этого поля нужно передавать в сообщении обязательно; 0..N – поле не обязательное и может появляться в сообщении 0 и более раз; 1..N – поле обязательное и может появляться в сообщении 1 и более раз.
Структура выходных данных (Response)
| Наименование структуры данных | <Код в PI> 1 | ||||
|---|---|---|---|---|---|
| Уровень | Наименование поля | Наименование объекта / данных | Тип данных | Наличие | Комментарий |
1 Кодирование производится по следующему правилу:
| Синтаксис | |
|---|---|
| Message Type | MT_ <Num System>_RSP_<Num Data Type> |
| Глоссарий | |
| <Num System> | Уникальный порядковый двухзначный номер бизнес-системы (см. описание систем) |
| <Num Data Type> | Уникальный порядковый трехзначный номер |
Например, MT_01_RSP_004
Алгоритм работы
Приводится описание алгоритма выгрузки данных.
Сообщение об ошибке (Fault)
| Наименование структуры данных | <Код в PI> | ||||
|---|---|---|---|---|---|
| Уровень | Наименование поля | Наименование объекта / данных | Тип данных | Наличие | Комментарий |