Лучшие практики присвоения имен элементам в Tulip

Назначение

Обзор наших лучших практик именования пользовательских элементов в Tulip в качестве отправной точки для ваших собственных приложений и соглашений об именовании.

Все пользовательские именованные элементы, например, переменные, шаги, записи и т.д., в Tulip должны быть названы таким образом, чтобы они были удобочитаемыми, однозначными и понятными для удобства использования приложений в течение их жизненного цикла.

Рекомендуется принять следующие общие соглашения об именовании для всех элементов:

• Описательное название
• Слова пишутся полностью, без сокращений
• Первая буква каждого слова в верхнем регистре, последующие буквы в нижнем регистре
• Отдельные слова разделяются пробелом

В следующих разделах приведены некоторые более подробные рекомендации для конкретных элементов.

Переменные

Имена переменных должны быть уникальными для приложения, однако одни и те же имена могут быть повторно использованы в рамках платформы Tulip.

• Тип переменной не включается в имя
• Сокращения единиц измерения записываются в круглых скобках рядом с именем числовых переменных

Регулируемые отрасли

Рекомендуется хранить значение и его единицу измерения в двух отдельных полях переменных/табличных записей, например, "Общий вес" и "Общий вес_UOM". Для получения дополнительной информации см. раздел "Лучшие практики создания приложений GxP".

Переменные, используемые для фильтрации таблиц

Переменные, используемые для фильтрации таблицы по определенному столбцу, следует называть с префиксом 'Filter'. Это повышает удобство использования этих переменных при создании приложений. Это рекомендуется для переменных, используемых исключительно для фильтрации. Переменные общего назначения в приложениях не нуждаются в префиксе.

Переменные для ключевых показателей

Для приложений с ключевыми показателями, например, CPPs/CQAs (критические параметры процесса / критические атрибуты процесса) или KPIs, добавьте префикс к названиям переменных, чтобы улучшить их читаемость.

Таблицы

Имена таблиц должны соответствовать тому же соглашению об именовании, которое используется для переменных, и должны быть сгруппированы с префиксом. Таблицы должны быть сгруппированы по общему назначению, например, для нескольких/всех случаев использования, или для конкретных случаев использования. Рекомендуется использовать '

' для группировки общего назначения и не использовать '*'. Символ '*' используется Tulip для маркировки таблиц, созданных в библиотеке Tulip Apps.

Триггеры

Не рекомендуется использовать стандартное имя "безымянного триггера". Вместо этого имя триггера должно описывать его функциональность в нескольких словах.