Регламент информационного взаимодействия «исуп ниаэп»

1.Общие положения

1. 
   «Регламент информационного взаимодействия «ИСУП НИАЭП» и ЕОНКОМ» (далее - Регламент) является документом Открытого акционерного общества Нижегородская инжиниринговая компания «АТОМЭНЕРГОПРОЕКТ» (далее – ОАО «НИАЭП») и устанавливает правила взаимодействия «ИСУП НИАЭП» и ЕОНКОМ. Настоящий документ вводится с момента утверждения и действует в течение всего времени функционирования систем ИСУП и СИО в ОАО «НИАЭП».
   
2. 
   Регламентом руководствуются структурные подразделения ОАО «НИАЭП», разработчики «ИСУП НИАЭП» и ЕОНКОМ.
   
3. 
   Регламент описывает механизм программного взаимодействия и атрибутный состав передаваемых данных на основе текущей рабочей версии «ИСУП НИАЭП» и ЕОНКОМ. Любые изменения систем, которые потребуют модификации интерфейса взаимодействия, должны быть включены в дополнение к настоящему регламенту после согласования сторон.
   
4. 
   Атрибутивный состав передаваемых данных описан в Технической спецификации к настоящему Регламенту.
   

2.Цель и назначение документа

2.1Цель документа

1. 
   Целью разработки настоящего регламента является определение правил для осуществления информационного взаимодействия между «ИСУП НИАЭП» и ЕОНКОМ в рамках единого информационного пространства НИАЭП при проектировании и строительстве АЭС.
   

2.2Назначение документа

2. 
   
   
   1. 
      способы синхронизации данных между «ИСУП НИАЭП» и ЕОНКОМ с целью синхронизации справочников оборудования и материалов;
      
   2. 
      описание процедур обмена данными между «ИСУП НИАЭП» и ЕОНКОМ.
      

3.Описание процедур обмена данными между «ИСУП НИАЭП» и ЕОНКОМ.

3.1Общие положения синхронизации справочников

3. 
   
   
   1. 
      
      
      1. 
         Процедура синхронизации позиций справочника «ИСУП НИАЭП» и ЕОНКОМ выполняется по инициативе одной из сторон.
         
      2. 
         ЕОНКОМ в качестве инициатора синхронизации выступает в случае ввода в каталог номенклатурной позиции по заявке специалистов ОАО «НИАЭП». Сценарий процедуры синхронизации приведен в разделе 3.2
         
      3. 
         «ИСУП НИАЭП» в качестве инициатора синхронизации выступает в случае появления в справочнике «ИСУП НИАЭП» номенклатурных позиций, у которых отсутствуют идентификационные данные позиции в ЕОНКОМ. Данная процедура также используется для первоначальной синхронизации справочника «ИСУП НИАЭП» и ЕОНКОМ. Сценарий процедуры синхронизации приведен в разделе 3.3.
         
      4. 
         Для информационного обмена данными между «ИСУП НИАЭП» и ЕОНКОМ используются интерфейсные таблицы. В зависимости от классификации номенклатурной позиции выгрузка данных осуществляется в одну из трех таблиц:
         

• 
  EONKOM_ARMAT_NOMEN – для номенклатурных позиций, классифицирующихся как арматура;
  
• 
  EONKOM_OBRD_NOMEN – для номенклатурных позиций, классифицирующихся как оборудование;
  
• 
  EONKOM_TRUB_NOMEN – для номенклатурных позиций, классифицирующихся как трубопроводы или детали трубопроводов.
  

5. 
   Классификация записей карточек оборудования и материалов в интерфейсной таблице осуществляется в соответствии с классификатором «ИСУП НИАЭП». Для обозначения, раздела классификатора, к которому относится запись в интерфейсной таблице, используются поля: «RAZDEL_ID» и «PODRAZDEL_ID». Значения и правила заполнения данных полей приведены в Технической спецификации к настоящему Регламенту.
   
6. 
   Интерфейсные таблицы находятся на стороне «ИСУП НИАЭП». Все интерфейсные таблицы реализованы на СУБД «Oracle».
   
7. 
   Обмен данными между двумя системами происходит на основе уникальных идентификаторов. Система – приемник хранит идентификаторы системы источника в специальных полях.
   

8. 
   В качестве идентификационных данных номенклатурной позиции в справочнике «ИСУП НИАЭП» используется её номенклатурный идентификатор в системе (поле «ISKS_NM_ID»).
   
9. 
   В качестве идентификационных данных номенклатурной позиции в справочнике ЕОНКОМ используется следующая информация:
   

• 
  «Системный идентификатор» (поле «EONKOM_OBJECT_ID»);
  
• 
  «Тип» (поле «EONKOM_TYPE») – указывающий на то, что коды ЕОНКОМ относятся к карточке оборудования и материалов.
  
• 
  «Системное имя» (поле «EONKOM_NAME») - идентификатор карточки оборудования и материалов в ЕОНКОМ;
  
• 
  «Номер ревизии» (поле «EONKOM_REVISION») - указывает на номер ревизии карточки оборудования и материалов в ЕОНКОМ.
  

10. 
    Связка идентификационных данных «ИСУП НИАЭП» и ЕОНКОМ в интерфейсных таблицах должны быть уникальной. Контроль уникальности данной связки выполняет средствами СУБД «Oracle».
    
11. 
    Признаком, что запись интерфейсной таблицы синхронизирована в «ИСУП НИАЭП» и ЕОНКОМ, является наличие у неё идентификационных данных обеих систем.
    

3.2Описание процедуры синхронизации справочников по инициативе «ЕОНКОМ»

2. 
   
   
   1. 
      Схематичное представление процедуры синхронизации справочников по инициативе ЕОНКОМ представлена на рисунке 1.
      

2. 
   ЕОНКОМ в качестве инициатора синхронизации справочников выступает в случае добавления номенклатурной позиции в справочник оборудования и материалов ЕОНКОН по заявке структурных подразделений ОАО «НИАЭП».
   
3. 
   При добавлении номенклатурной позиции в справочник, ЕОНКОМ формирует в соответствующей интерфейсной таблице (см. 3.1.4) запись.
   

4. 
   «ИСУП НИАЭП» обрабатывает запись интерфейсной таблицы и создает в своем справочнике карточку номенклатуры.
   

5. 
   После того как в «ИСУП НИАЭП» сформирована номенклатурная карточка и ей присвоен уникальный идентификационный номер, он выгружается в поле «ISKS_NM_ID» соответствующей записи в интерфейсной таблице.
   

6. 
   ЕОНКОМ считывает идентификатор номенклатурной позиции в «ИСУП НИАЭП» и записывает его в соответствующую карточку своего каталога.
   

7. 
   Во всех интерфейсных таблицах осуществляется контроль целостности данных (полнота заполнения служебных полей интерфейсной таблицы и атрибутных полей карточки номенклатуры) средствами СУБД «Oracle».
   

3.3Описание процедуры синхронизации справочников по инициативе «ИСУП НИАЭП»

3. 
   
   
   1. 
      Схематичное представление процедуры синхронизации справочников по инициативе «ИСУП НИАЭП» представлена на рисунке 2.
      

2. 
   «ИСУП НИАЭП» в качестве инициатора синхронизации выступает в случае появления в справочнике позиций, у которых отсутствуют идентификационные данные ЕОНКОМ (Например: позиция добавляется в справочник из внешних систем: ПК «СИО», База данных оборудования сторонних организаций и др.)
   
3. 
   «ИСУП НИАЭП» формирует и выгружает в интерфейсную таблицу позиции номенклатурного справочника с отсутствующими идентификационными данными ЕОНКОМ.
   

4. 
   ЕОНКОМ осуществляет загрузку данных из интерфейсной таблицы и осуществляет их сверку на предмет наличия соответствующей карточки в справочнике ЕОНКОМ.
   

5. 
   В случае отсутствия в ЕОНКОМ подходящей карточки оборудования, осуществляет её формирование.
   

6. 
   После обработки загруженных данных и формирования, при необходимости, новых карточек ЕОНКОМ осуществляет выгрузку идентификационных данных в интерфейсную таблицу в привязке к соответствующим позициям.
   

7. 
   «ИСУП НИАЭП» выполняет загрузку идентификационных данных ЕОНКОМ из интерфейсных таблиц в привязке к соответствующим карточкам справочника.
   

3.4Технический регламент процедуры синхронизации

1. 
   
   
   1. 
      Для идентификации системы, создавшей запись в интерфейсной таблице, используется поле «Система источник» (SRC_SYSTEM). В случае, когда запись в интерфейсной таблице создает «ИСУП НИАЭП», в поле устанавливается значение «ISUP_NIAEP», в случае ЕОНКОМ - значение «EONKOM».
      
   2. 
      Для обработки и контроля выполнения процедуры синхронизации в интерфейсных таблицах предназначены специальные служебные поля:
      

• 
  Поле «Статус записи» (STATUS_REC) – поле-флаг, отражающее статус записи в интерфейсной таблице («I» - запись добавлена в интерфейсную таблицу; «U» - запись в интерфейсной таблице обновлена; «D» - запись удалена);
  
• 
  Поле «Дата и время создания» («DATE_CREATE») – содержит дату и время создания записи в интерфейсной таблице.
  
• 
  Поле «Статус обработки со стороны «ИСУП НИАЭП» (STATUS_PRC_ISUP) – поле-флаг, отражает статус обработки записи со стороны «ИСУП НИАЭП» («N» - запись со стороны «ИСУП НИАЭП» не обработана; «R» - запись со стороны «ИСУП НИАЭП» обработана успешно; «E» - при обработке записи со стороны «ИСУП НИАЭП» возникли ошибки);
  
• 
  Поле «Дата и время обработки со стороны «ИСУП НИАЭП» («PROCESS_DATE_ISUP») – содержит дату и время старта процедуры обработки записи на стороне «ИСУП НИАЭП»;
  
• 
  Поле «Протокол обработки записи со стороны «ИСУП НИАЭП» (PROTOCOL_ISUP) – содержит сведения об обработке записи, а также информацию об ошибках обработки записи на стороне «ИСУП НИАЭП»;
  
• 
  Поле «Статус обработки со стороны ЕОНКОМ» (STATUS_PRC_EONKOM) – поле-флаг, отражает статус обработки записи со стороны ЕОНКОМ («N» - запись со стороны ЕОНКОМ не обработана; «R» - запись со стороны ЕОНКОМ обработана успешно; «E» - при обработке записи со стороны ЕОНКОМ возникли ошибки);
  
• 
  
  

• 
  Поле «Дата и время обработки со стороны ЕОНКОМ» («PROCESS_DATE_ EONKOM») – содержит дату и время старта процедуры обработки записи на стороне ЕОНКОМ;
  
• 
  Поле «Протокол обработки записи со стороны ЕОНКОМ» (PROTOCOL_ EONKOM) – содержит сведения об обработке записи, а также информацию об ошибках обработки записи на стороне ЕОНКОМ».
  

1. 
   При добавлении новой записи в интерфейсную таблицу устанавливаются следующие значения в служебные поля:
   
   1. 
      Запись добавляется «ИСУП НИАЭП»:
      

• 
  Поле «Статус записи» (STATUS_REC) = «I»;
  
• 
  Поле «Дата и время создания» («DATE_CREATE») = Дата и время создания записи в интерфейсной таблице;
  
• 
  Поле «Статус обработки со стороны «ИСУП НИАЭП» (STATUS_PRC_ISUP) = NULL;
  
• 
  Поле «Дата и время обработки со стороны «ИСУП НИАЭП» («PROCESS_DATE_ISUP») = NULL;
  
• 
  Поле «Протокол обработки записи со стороны «ИСУП НИАЭП» (PROTOCOL_ISUP) = NULL;
  
• 
  «Статус обработки со стороны ЕОНКОМ» (STATUS_PRC_EONKOM) = «N»;
  
• 
  Поле «Дата и время обработки со стороны ЕОНКОМ» («PROCESS_DATE_ EONKOM») = NULL;
  
• 
  Поле «Протокол обработки записи со стороны ЕОНКОМ» (PROTOCOL_ EONKOM) = NULL.
  

1. 
   Запись добавляется ЕОНКОМ:
   

• 
  Поле «Статус записи» (STATUS_REC) = «I»;
  
• 
  Поле «Дата и время создания» («DATE_CREATE») = Дата и время создания записи в интерфейсной таблице;
  
• 
  Поле «Статус обработки со стороны «ИСУП НИАЭП» (STATUS_PRC_ISUP) = «N»;
  
• 
  Поле «Дата и время обработки со стороны «ИСУП НИАЭП» («PROCESS_DATE_ISUP») = NULL;
  

• 
  Поле «Протокол обработки записи со стороны «ИСУП НИАЭП» (PROTOCOL_ISUP) = NULL;
  
• 
  «Статус обработки со стороны ЕОНКОМ» (STATUS_PRC_EONKOM) = NULL;
  
• 
  Поле «Дата и время обработки со стороны ЕОНКОМ» («PROCESS_DATE_ EONKOM») = NULL;
  
• 
  Поле «Протокол обработки записи со стороны ЕОНКОМ» (PROTOCOL_ EONKOM) = NULL.
  

1. 
   При успешном считывании записи в интерфейсной таблице устанавливаются признаки:
   
   1. 
      Запись успешно считана «ИСУП НИАЭП»:
      

• 
  Поле «Статус записи» (STATUS_REC) = не изменяется;
  
• 
  Поле «Дата и время создания» («DATE_CREATE») = не изменяется;
  
• 
  Поле «Статус обработки со стороны «ИСУП НИАЭП» (STATUS_PRC_ISUP) = «R»;
  
• 
  Поле «Дата и время обработки со стороны «ИСУП НИАЭП» («PROCESS_DATE_ISUP») = Дата и время старта процедуры обработки;
  
• 
  Поле «Протокол обработки записи со стороны «ИСУП НИАЭП» (PROTOCOL_ISUP) = отметка об успешном завершении процесса обработки записи;
  
• 
  «Статус обработки со стороны ЕОНКОМ» (STATUS_PRC_EONKOM) = не изменяется;
  
• 
  Поле «Дата и время обработки со стороны ЕОНКОМ» («PROCESS_DATE_ EONKOM») = не изменяется;
  
• 
  Поле «Протокол обработки записи со стороны ЕОНКОМ» (PROTOCOL_ EONKOM) = не изменяется.
  

1. 
   Запись успешно считана ЕОНКОМ:
   

• 
  Поле «Статус записи» (STATUS_REC) = не изменяется;
  
• 
  Поле «Дата и время создания» («DATE_CREATE») = не изменяется;
  
• 
  Поле «Статус обработки со стороны «ИСУП НИАЭП» (STATUS_PRC_ISUP) = не изменяется;
  
• 
  
  

• 
  Поле «Дата и время обработки со стороны «ИСУП НИАЭП» («PROCESS_DATE_ISUP») = не изменяется;
  
• 
  Поле «Протокол обработки записи со стороны «ИСУП НИАЭП» (PROTOCOL_ISUP) = не изменяется;
  
• 
  «Статус обработки со стороны ЕОНКОМ» (STATUS_PRC_EONKOM) = «R»;
  
• 
  Поле «Дата и время обработки со стороны ЕОНКОМ» («PROCESS_DATE_ EONKOM») = Дата и время старта процедуры обработки;
  
• 
  Поле «Протокол обработки записи со стороны ЕОНКОМ» (PROTOCOL_ EONKOM) = отметка об успешном завершении процесса обработки записи.
  

1. 
   При возникновении ошибки обработки записи в интерфейсной таблице строке устанавливаются признаки:
   
   1. 
      Ошибка возникла в процессе загрузки данных в «ИСУП НИАЭП»:
      

• 
  Поле «Статус записи» (STATUS_REC) = не изменяется;
  
• 
  Поле «Дата и время создания» («DATE_CREATE») = не изменяется;
  
• 
  Поле «Статус обработки со стороны «ИСУП НИАЭП» (STATUS_PRC_ISUP) = «E»;
  
• 
  Поле «Дата и время обработки со стороны «ИСУП НИАЭП» («PROCESS_DATE_ISUP») = Дата и время старта процедуры обработки;
  
• 
  Поле «Протокол обработки записи со стороны «ИСУП НИАЭП» (PROTOCOL_ISUP) = описание ошибки;
  
• 
  «Статус обработки со стороны ЕОНКОМ» (STATUS_PRC_EONKOM) = не изменяется;
  
• 
  Поле «Дата и время обработки со стороны ЕОНКОМ» («PROCESS_DATE_ EONKOM») = не изменяется;
  
• 
  Поле «Протокол обработки записи со стороны ЕОНКОМ» (PROTOCOL_ EONKOM) = не изменяется.
  

1. 
   Ошибка возникла в процессе загрузки данных в ЕОНКОМ:
   

• 
  Поле «Статус записи» (STATUS_REC) = не изменяется;
  
• 
  Поле «Дата и время создания» («DATE_CREATE») = не изменяется;
  

• 
  Поле «Статус обработки со стороны «ИСУП НИАЭП» (STATUS_PRC_ISUP) = не изменяется;
  
• 
  Поле «Дата и время обработки со стороны «ИСУП НИАЭП» («PROCESS_DATE_ISUP») = не изменяется;
  
• 
  Поле «Протокол обработки записи со стороны «ИСУП НИАЭП» (PROTOCOL_ISUP) = не изменяется;
  
• 
  «Статус обработки со стороны ЕОНКОМ» (STATUS_PRC_EONKOM) = «E»;
  
• 
  Поле «Дата и время обработки со стороны ЕОНКОМ» («PROCESS_DATE_ EONKOM») = Дата и время старта процедуры обработки;
  
• 
  Поле «Протокол обработки записи со стороны ЕОНКОМ» (PROTOCOL_ EONKOM) = описание ошибки.
  

6. 
   Формат интерфейсных таблиц, набор атрибутов и правила обработки описаны в «Технической спецификации интерфейса взаимодействия».