Модуль в этой статье: iFlow Inspector
Чек-лист ревью iFlow в SAP CPI и как его автоматизировать
Практический чек-лист ревью iFlow в SAP CPI: обработка ошибок, уровни журнала, секреты, протоколы, скрипты и структура — и как запускать его автоматически с баллом и отчётом.
Ревью iFlow обычно проходит в спешке, прямо перед транспортом, и проверяет то, что вспомнит ревьюер. В итоге одни и те же проблемы снова и снова доходят до продуктива: нет обработки ошибок, пароль в Content Modifier, Router без маршрута по умолчанию.
В этой статье — чек-лист из двенадцати проверок для iFlow SAP Cloud Integration (SAP CPI), объяснение, почему важна каждая, и способ запускать их автоматически, с баллом и отчётом, который можно приложить к транспорту.
Когда проводить ревью iFlow
- Перед первым транспортом в тестовый или продуктивный tenant.
- Когда iFlow передаётся другому разработчику или в эксплуатацию.
- После крупного изменения, например нового получателя или нового скрипта.
- Время от времени — для iFlow, которые разрослись за годы.
Чек-лист
| Проверка | Почему это важно | Категория |
|---|---|---|
| Нет Exception Subprocess | Ошибка завершает сообщение стандартной обработкой SAP: ни оповещения, ни внятного ответа отправителю. | Надёжность |
| Подробный уровень логирования | Журналирование каждого шага замедляет каждое сообщение и заполняет хранилище журналов tenant. | Производительность |
| Нет описания | Другие не поймут, что делает iFlow и кто за него отвечает, не открыв его. | Сопровождаемость |
| Секрет в открытом виде | Любой, кто может открыть или скачать iFlow, прочитает записанный в нём пароль или токен. | Безопасность |
| Шаг скрипта без скрипта | Шаг скрипта без файла скрипта падает во время выполнения. | Корректность |
| Большой процесс | Процесс с множеством шагов трудно читать, тестировать и менять. | Сопровождаемость |
| Небезопасный протокол | Обычные HTTP или FTP передают данные, а также учётные данные Basic, без шифрования. | Безопасность |
| Вызов без Receiver | Шагу Request Reply или Send без канала некуда отправить сообщение. | Корректность |
| Риск в скрипте | println, чтение большого тела в одну String, очень длинные скрипты, XML-парсеры, уязвимые для XXE. | Производительность |
| Неиспользуемый Local Integration Process | Его не вызывает ни один Process Call, поэтому он никогда не выполняется. | Сопровождаемость |
| Шаг не подключён | К нему не ведёт ни один путь от стартового события, поэтому он никогда не выполняется. | Корректность |
| Router без маршрута по умолчанию | Если ни одно условие не подошло, сообщение падает, вместо того чтобы пойти по известному пути. | Надёжность |
Это категории, которые использует Kitegra. При ручном ревью важно, чтобы у каждой проверки были причина и исправление, о которых команда договорилась.
Чего чек-лист не видит
Проверки читают дизайн iFlow. Они не знают, верен ли маппинг с точки зрения бизнеса, выдержит ли получатель нагрузку и доходит ли оповещение из обработки ошибок до того, кто его читает. Для этих вопросов ревью по-прежнему нужен человек, а также тест на правдоподобных данных.
Имена — отдельная часть ревью: набор правил именования позволяет проверять и их.
Запускайте проверки автоматически
В Kitegra откройте iFlow, нажмите кнопку «Инструменты Kitegra» и выберите «Инспектор». Его вкладка «Дизайн» запускает двенадцать проверок выше на открытом iFlow и его скриптах:
- Каждая находка показывает, почему она важна, и строку «Решение:».
- «Балл (0–100) и оценка» подытоживает iFlow оценкой от A до E.
- «Настройки проверок» отключают проверку или меняют её вес в балле; эти настройки синхронизируются с вашим аккаунтом Kitegra.
- «Задать базовую линию» отмечает сегодняшние находки как известные, чтобы следующее ревью показывало только новое.
- «Скрыть» скрывает одну находку и спрашивает причину; «Показать известные и скрытые» возвращает их.
Одна из проверок касается уровня журнала; почему TRACE не стоит оставлять включённым, объясняет статья об уровне TRACE.
Поделитесь результатом в виде отчёта
«Отчёт» открывает отчёт iFlow в новой вкладке: факты об iFlow (шаги, скрипты, адаптеры, процессы), его балл, находки дизайна с фильтром по категории или важности и находки по именованию. Экспортируйте его в HTML, PDF или Excel или отправьте на «Печать». В разделе «Шапка отчёта» можно добавить название компании и логотип размером до 20 KB.
Отчёт строится по модели iFlow и не содержит содержимого сообщений. Подписи в PDF — на английском.
Чем помогает Kitegra
Проверки дизайна — часть iFlow Inspector в Kitegra. Они выполняются в вашем браузере на открытом iFlow; настройки проверок и базовые линии синхронизируются с аккаунтом Kitegra, когда вы входите, а скрипты и маппинги никогда не отправляются.
Helper, Message Monitor, iFlow Inspector и iFlow Docs по отдельности считают iFlow, на которых вы их используете: 5 на модуль без аккаунта Kitegra, 50 на тарифе Free, 100 на Starter и 300 на Pro; Startup Team даёт каждому участнику 300, у Growth Team и Scale Team ограничений нет. Toolbox и дополнения для рабочего пространства iFlow не учитывают. Пока Kitegra запускается, все инструменты открыты для всех, кто вошёл в аккаунт, в том числе на тарифе Free. Сравните тарифы.
Попробуйте в следующем iFlow
Узнайте, что Kitegra добавляет к дизайнеру SAP Integration Suite, или посмотрите его рядом с другими расширениями Kitegra для Chrome.
Частые вопросы
Что должно проверять ревью iFlow в SAP CPI?
Обработку ошибок, уровень журнала, описание, секреты в открытом виде, скрипты, безопасность протоколов, неподключённые или неиспользуемые части и маршруты Router по умолчанию, а также имена и бизнес-логику.
Чем плох Router без маршрута по умолчанию?
Если ни одно условие не подошло, сообщение падает, вместо того чтобы пойти по известному пути.
Как вычисляется балл?
Каждая находка снижает балл от 100 на вес, зависящий от её важности, а балл соответствует оценке от A до E. Вес каждой проверки можно изменить.
Что делает «Задать базовую линию»?
Отмечает сегодняшние находки как известные, чтобы последующее ревью показывало только новые.
Можно ли экспортировать ревью?
Да. Отчёт iFlow экспортируется в HTML, PDF или Excel с названием и логотипом вашей компании.
Есть ли в отчёте содержимое сообщений?
Нет. Он строится по модели iFlow и не содержит содержимого сообщений.