СРК 05.1 Свойства объектов метаданных

Для партнеров фирмы «1С», участвующих в бета-тестировании «1С:Предприятия 8.0»
Настоящий документ является рабочим материалом фирмы «1С» и предназначен для ознакомления партнеров фирмы «1С» с техническими и проектными
решениями, используемыми при разработке типовых конфигураций для платформы «1С:Предприятие 8.0».
Данный документ не является окончательной редакцией и в него могут быть внесены изменения.
Публикация, цитирование или иное распространение данного документа или его фрагментов без согласия фирмы «1С» не разрешается.
Система стандартов и регламентов разработки конфигураций для
платформы «1С:Предприятие 8.0»
СТП СРК. 05.001.01
Свойства объектов метаданных
Дата последней модификации: 30 апреля 2003 г.
Предмет стандартизации ........................................................................................................................................................................ 2
Общие требования к имени, синониму, комментарию ........................................................................................................................ 2
Общие требования к типам (реквизитов и пр.) .................................................................................................................................... 2
Общие требования к ведущим объектам .............................................................................................................................................. 3
Общие требования к реквизитам и табличным частям объектов ....................................................................................................... 3
Общие требования к формам объектов ................................................................................................................................................. 3
Общие требования к макетам объектов ................................................................................................................................................ 3
Конфигурация ......................................................................................................................................................................................... 3
Общие ...................................................................................................................................................................................................... 4
Подсистемы ........................................................................................................................................................................................ 4
Общие модули .................................................................................................................................................................................... 4
Роли ..................................................................................................................................................................................................... 4
Критерии отбора ................................................................................................................................................................................. 4
Интерфейсы ........................................................................................................................................................................................ 4
Общие формы ..................................................................................................................................................................................... 4
Общие макеты .................................................................................................................................................................................... 4
Общие картинки ................................................................................................................................................................................. 4
Стили ................................................................................................................................................................................................... 4
Элементы стиля .................................................................................................................................................................................. 4
Языки................................................................................................................................................................................................... 4
Константы ................................................................................................................................................................................................ 4
Справочники ............................................................................................................................................................................................ 4
Реквизиты и табличные части справочников .................................................................................................................................. 5
Формы справочников ......................................................................................................................................................................... 5
Макеты справочников ........................................................................................................................................................................ 5
Нумераторы документов ........................................................................................................................................................................ 5
Последовательности документов .......................................................................................................................................................... 5
Измерения последовательностей ...................................................................................................................................................... 6
Документы ............................................................................................................................................................................................... 6
Реквизиты и табличные части документов ...................................................................................................................................... 6
Формы документов ............................................................................................................................................................................ 6
Макеты документов ........................................................................................................................................................................... 6
Журналы документов ............................................................................................................................................................................. 6
Графы журналов ................................................................................................................................................................................. 6
Формы журналов ................................................................................................................................................................................ 6
Макеты журналов ............................................................................................................................................................................... 6
Перечисления .......................................................................................................................................................................................... 6
Значения перечислений ..................................................................................................................................................................... 6
Отчеты и обработки ................................................................................................................................................................................ 7
Реквизиты и табличные части отчетов и обработок ....................................................................................................................... 7
Формы отчетов и обработок .............................................................................................................................................................. 7
Макеты отчетов и обработок ............................................................................................................................................................. 7
Регистры сведений .................................................................................................................................................................................. 7
Измерения регистров сведений ......................................................................................................................................................... 7
Ресурсы регистров сведений ............................................................................................................................................................. 7
Реквизиты регистров сведений ......................................................................................................................................................... 7
Формы регистров сведений ............................................................................................................................................................... 7
Макеты регистров сведений .............................................................................................................................................................. 7
Регистры накопления .............................................................................................................................................................................. 8
Измерения регистров накопления .................................................................................................................................................... 8
Ресурсы регистров накопления ......................................................................................................................................................... 8
Реквизиты регистров накопления ..................................................................................................................................................... 8
Формы регистров накопления ........................................................................................................................................................... 8
Макеты регистров накопления .......................................................................................................................................................... 8
Предмет стандартизации
Правила, которым должны соответствовать объекты метаданных.
Общие требования к имени, синониму, комментарию
Имя объекта надо стремиться строить на основе синонима объекта так, как это делает система автоматически: пробелы и пр.
недопустимые символы удаляются, первые буквы слов делаются заглавными.
Сокращения слов (относительно синонима) допускаются только в крайних случаях, при этом необходимо, чтобы по сокращению можно было восстановить слово обратно. Допустимые сокращения описаны в Стандарты именования переменных и
процедур.doc.
В случае длинных синонимов последние слова могут быть опущены, ели это не искажает смысла.
Для реквизитов объектов допускается переставлять слова из синонима местами, например: синоним «Полное наименование», имя «НаименованиеПолное». Для ведущих объектов подобное не допускается.
Синоним объекта должен быть определен так, чтобы осмысленно описывать объект.
Сокращения допускаются только общепринятые, например, «ОКЕИ», «ИНН».
Следует избегать излишне длинных синонимов, но и укорачивать их с потерей смысла тоже плохо.
Для ведущих объектов метаданных необходимо стремиться к тому, чтобы название объекта в меню, подпись в диалоговых
формах совпадали с синонимом или, как минимум, начинались с него.
Для реквизитов объектов подписи в диалогах могут отличаться «в силу обстоятельств» - синоним надо подбирать так, чтобы
он осмысленно описывал реквизит в возможных универсальных формах.
Для форм синоним должен начинаться со слов, генерируемых конструктором при создании формы («Форма списка…»,
«Форма элемента…» и т. д.), далее обязательно должно следовать уточнение, например «Форма элемента полная», «Форма
элемента упрощенная».
Синоним начинается с большой буквы, точки ставятся только после сокращений.
Для макетов унифицированных форм синоним должен состоять из названия формы, например: «ТОРГ-12».
В отношении ведущих объектов метаданных сложилась традиция:
 в синонимах объектов управленческого учета упоминать компанию, например: «Подразделения компании»;
 в синонимах объектов, подчиненных справочнику «Организации», упоминать организацию, например: «Подразделения
организаций».
Комментарий задается только в тех случаях, когда необходимы какие-либо пояснения.
Если в синониме использовано сокращение, в комментарии необходимо его расшифровать, например: «Общероссийский
классификатор единиц измерения».
Для реквизитов объектов в комментариях в необходимых случаях должно содержаться уточнение, например: «Сумма со
всеми налогами».
Комментарий начинается с большой буквы, точки ставятся только после сокращений.
Общие требования к типам (реквизитов и пр.)
Числовой тип: ограничения могут быть следующие:
1. Реквизиты типа флаг (0/1)
не делаем, применяем булев тип данных.
2. Реквизиты типа сумма:
длина 15, точность 2.
3. Реквизиты типа количество:
длина 15, точность 3.
4. Реквизиты типа коэффициент:
длина 10, точность 3.
5. Реквизиты типа курс:
длина 10, точность 4.
6. Реквизиты типа процент:
длина 5, точность 2.
Строковый тип:


Допустимая длина должна быть в большинстве случаев переменной – это означает, что при получении значения
реквизита из него автоматически будут удаляться пробелы справа.
Неограниченная длина должна назначаться, если:
1. Не требуется поиск, отбор и т. д. по реквизиту (т. к. поиск работать не будет ни в каком виде)
2. Реквизит часто может быть не заполнен, или количество символов больше 100 (т. к. строки неограниченной
длины хранятся порциями, а пустые места не занимают совсем).
Общие требования к ведущим объектам
Сортировка: ведущие объекты в дереве метаданных сортируются по представлению по возрастанию – это облегчает их
выбор в режиме «1С:Предприятие» в системных формах выбора вида объекта.
Общие требования к имени, синониму, комментарию
Принадлежность к подсистемам: обязательно должна быть указана принадлежность объекта к конкретным подсистемам.
Не следует задавать принадлежность всей конфигурации.
Включение справочной информации в содержание помощи: для ведущих объектов метаданных справочная информация
включается в содержание помощи.
Общие требования к реквизитам и табличным частям объектов
Сортировка: реквизиты и табличные части объектов в дереве метаданных сортируются по имени по возрастанию.
Общие требования к имени, синониму, комментарию
Индексирование: индексировать следует только те реквизиты, по которым часто выполняются сортировка, отбор, поиск и т.
д. Все это будет работать и без индексирования, но медленнее. Индексирование снижает скорость записи и увеличивает объем базы.
Общие требования к типам
Общие требования к формам объектов
Общие требования к имени, синониму, комментарию
Сортировка: формы в дереве метаданных сортируются в следующем порядке:
 Формы списка (для справочников, документов)
 Формы выбора (для справочников, документов)
 Формы выбора группы (для справочников)
 Формы объекта (элемента, документа, отчета и т. д).
 Формы группы (для справочников)
 Произвольные формы
Внутри каждой группы формы, если их несколько, сортируются по имени по возрастанию.
Включение справочной информации в содержание помощи: для форм объектов справочная информация в содержание
помощи не включается.
Общие требования к макетам объектов
Общие требования к имени, синониму, комментарию
Сортировка: макеты в дереве метаданных сортируются по имени по возрастанию.
Конфигурация
Общие требования к имени, синониму, комментарию
Синоним
<полное название конфигурации>, редакция <номер
редакции>.<номер подредакции>
Имя
образуется по правилам образования имен из синонима
Краткая информация
повторяет синоним
Подробная информация
повторяет синоним
Поставщик
указывается «Фирма "1С"»
Номер релиза
указывается в соответствии с правилами нумерации релизов
Вариант встроенного языка должен быть указан «Русский».
Округление должно быть установлено «Округлять 1.5 до 2».
Основной стиль должен быть определен обязательно.
Основной язык должен быть указан «Русский».
Основной интерфейс должен быть определен обязательно.
Основная роль должна быть определена обязательно.
Краткая информация
Развернутая информация
Поставщик
Релиз
Включать справку в содержание помощи
Основная форма констант должна быть определена обязательно.
Общие
Подсистемы
Общие требования к ведущим объектам
Общие модули
Общие требования к ведущим объектам
Роли
Общие требования к ведущим объектам
Права
Критерии отбора
Общие требования к ведущим объектам
Состав критерия назначается в соответствии с проектной логикой.
Общие требования к типам
Основная форма должна быть определена обязательно.
Общие требования к формам объектов
Интерфейсы
Общие требования к ведущим объектам
Переключаемый
Общие формы
Общие требования к формам объектов
Общие макеты
Общие требования к ведущим объектам
Общие картинки
Общие требования к ведущим объектам
Стили
Общие требования к ведущим объектам
Элементы стиля
Общие требования к ведущим объектам
Вид
Языки
Общие требования к ведущим объектам
Код языка для русского языка должен быть указан «ru».
Константы
Общие требования к ведущим объектам
Общие требования к типам
Справочники
Общие требования к ведущим объектам
Иерархический
Вид иерархии
Ограничивать количество уровней
Количество уровней, если справочник иерархический, всегда сразу максимальное – 10.
Размещать группы сверху
Владельцы назначаются в соответствии с проектной логикой.
Длина кода, если не определяется проектной логикой, должна быть фиксированной: 5 символов. Считаем, что этого достаточно для любого справочника любой типовой конфигурации. При наличии префиксации длина кода увеличивается на допустимую длину префикса (на 3 символа).
Длина наименования. Следует избегать завышенной длины наименования, поскольку оно в большинстве случаев является
основным представлением и должно занимать «умеренное» количество места в диалоговых формах. Для большего порядка
предлагается пользоваться вариантами:
 25
для «небольших» справочников.
 50
для тех справочников, кому 25 мало.
 100
для тех справочников, кому 50 мало.
Тип кода, если не определяется проектной логикой, назначается «Строка».
Серии кодов, если не определяются проектной логикой, назначаются «Во всем справочнике».
Контроль уникальности, если не определяется проектной логикой, должен быть включен.
Авто нумерация, если не определяется проектной логикой, должна быть включена.
Вводится на основании – назначается в соответствии с проектной логикой.
Основное представление, если не определяется проектной логикой, должно быть «В виде наименования».
Способ редактирования надо назначать по следующим правилам:
 «В списке» – если справочник не имеет большого количества реквизитов и пр. особенностей, при которых желательно иметь форму элемента.
 «Обоими способами» – если разработана форма элемента, желательно все равно поддерживать режим редактирования (видимых реквизитов) в списке, поскольку так во многих случаях быстрее, просматривая список, что-либо поправить. Допустимо вводить ограничения, например, для ввода нового вызывать форму элемента.
 «В диалоге» – только в случаях, когда запрет редактирования в списке серьезно обоснован.
Основная форма элемента должна быть назначена, если допускается редактирование в диалоге или открытие элемента из
полей ввода (по кнопке «Открыть»).
Основная форма группы должна быть назначена, если справочник многоуровневый и допускается редактирование в диалоге или открытие группы из полей ввода (по кнопке «Открыть»). Может совпадать с формой элемента, если большинство
реквизитов у группы и элемента совпадают (в этом случае в форме надо учитывать отличия между элементом и группой,
если они имеются).
Основная форма списка должна быть назначена всегда.
Основная форма для выбора должна быть назначена всегда. Должна отличаться от формы списка, только если есть необходимость в существенных отличиях форм списка и выбора.
Основная форма для выбора группы должна быть назначена всегда, если справочник многоуровневый.
Реквизиты и табличные части справочников
Общие требования к реквизитам и табличным частям объектов
Использование реквизита и табличной части для групп и элементов назначается в соответствии с проектной логикой.
Формы справочников
Общие требования к формам объектов
Макеты справочников
Общие требования к макетам объектов
Нумераторы документов
Сортировка: нумераторы в дереве метаданных сортируются по имени по возрастанию.
Общие требования к имени, синониму, комментарию
Принадлежность к подсистемам: обязательно должна быть указана принадлежность нумератора к конкретным подсистемам. Не следует задавать принадлежность всей конфигурации.
Тип номера, если не определяется проектной логикой, назначается «Строка».
Длина номера, если не определяется проектной логикой, должна быть фиксированной: 5 символов. Считаем, что этого достаточно для любого документа любой типовой конфигурации. При наличии префиксации длина номера увеличивается на
допустимую длину префикса (на 3 символа).
Периодичность номера, если не определяются проектной логикой, назначаются «Год».
Контроль уникальности номера, если не определяется проектной логикой, должен быть включен.
Последовательности документов
Сортировка: последовательности в дереве метаданных сортируются по имени по возрастанию.
Общие требования к имени, синониму, комментарию
Принадлежность к подсистемам: обязательно должна быть указана принадлежность последовательности к конкретным
подсистемам. Не следует задавать принадлежность всей конфигурации.
Документы, входящие в последовательность задаются в соответствии с проектной логикой.
Движения, влияющие на последовательность, задаются в соответствии с проектной логикой.
Измерения последовательностей
Сортировка: измерения последовательностей в дереве метаданных сортируются в соответствии с проектной логикой.
Общие требования к имени, синониму, комментарию
Общие требования к типам
Соответствие документам задаются в соответствии с проектной логикой.
Соответствие движениям задаются в соответствии с проектной логикой.
Документы
Общие требования к ведущим объектам
Нумератор определяется проектной логикой.
Тип номера
Длина номера
Периодичность номера
Контроль уникальности номера
Авто нумерация, если не определяется проектной логикой, должна быть включена.
Вводится на основании – назначается в соответствии с проектной логикой.
Проведение разрешается или запрещается в соответствии с проектной логикой.
Оперативное проведение
Удаление движений автоматически или нет – назначается в соответствии с проектной логикой.
Движения каких регистров осуществляет документ – указывается в соответствии с проектной логикой
Основная форма документа должна быть назначена всегда.
Основная форма списка должна быть назначена всегда.
Основная форма для выбора должна быть назначена всегда. Должна отличаться от формы списка, только если есть необходимость в существенных отличиях форм списка и выбора.
Реквизиты и табличные части документов
Общие требования к реквизитам и табличным частям объектов
Формы документов
Общие требования к формам объектов
Макеты документов
Общие требования к макетам объектов
Журналы документов
Общие требования к ведущим объектам
Основная форма должна быть определена обязательно.
Регистрируемые документы задаются в соответствии с проектной логикой.
Графы журналов
Сортировка: графы журналов в дереве метаданных сортируются по имени по возрастанию.
Общие требования к имени, синониму, комментарию
Ссылки задаются в соответствии с проектной логикой.
Формы журналов
Общие требования к формам объектов
Макеты журналов
Общие требования к макетам объектов
Перечисления
Общие требования к ведущим объектам
Значения перечислений
Сортировка: значения перечислений в дереве метаданных сортируются в том порядке, который наиболее удобен при выборе значения.
Общие требования к имени, синониму, комментарию
Отчеты и обработки
Общие требования к ведущим объектам
Основная форма должна быть назначена обязательно, если предполагается работа с отчетом, обработкой в интерактивном
режиме.
Реквизиты и табличные части отчетов и обработок
Общие требования к реквизитам и табличным частям объектов
Формы отчетов и обработок
Общие требования к формам объектов
Макеты отчетов и обработок
Общие требования к макетам объектов
Регистры сведений
Общие требования к ведущим объектам
Способ редактирования надо назначать по следующим правилам:
 «В списке» – если регистр не имеет большого количества реквизитов и пр. особенностей, при которых желательно
иметь форму записи.
 «Обоими способами» – если разработана форма записи, желательно все равно поддерживать режим редактирования
(видимых реквизитов) в списке, поскольку так во многих случаях быстрее, просматривая список, что-либо поправить. Допустимо вводить ограничения, например, для ввода новой вызывать форму записи.
 «В диалоге» – только в случаях, когда запрет редактирования в списке серьезно обоснован.
Основная форма записи должна быть назначена, если допускается редактирование в диалоге.
Основная форма списка должна быть назначена обязательно, если предполагается работа с регистром в интерактивном
режиме.
Периодичность регистра сведений назначается в соответствии с проектной логикой.
Режим записи назначается в соответствии с проектной логикой.
Измерения регистров сведений
Сортировка: измерения регистров сведений в дереве метаданных сортируются в соответствии с проектной логикой.
Общие требования к имени, синониму, комментарию
Ведущее измерение – назначается в соответствии с проектной логикой.
Запрет пустых значений назначается в соответствии с проектной логикой.
Индексирование: индексировать следует только те измерения, по которым часто выполняются сортировка, отбор, поиск и т.
д. Все это будет работать и без индексирования, но медленнее. Индексирование снижает скорость записи и увеличивает объем базы.
Общие требования к типам
Ресурсы регистров сведений
Сортировка: ресурсы регистров сведений в дереве метаданных сортируются по имени в порядке возрастания.
Общие требования к имени, синониму, комментарию
Общие требования к типам
Реквизиты регистров сведений
Сортировка: реквизиты регистров сведений в дереве метаданных сортируются по имени в порядке возрастания.
Общие требования к имени, синониму, комментарию
Общие требования к типам
Формы регистров сведений
Общие требования к формам объектов
Макеты регистров сведений
Общие требования к макетам объектов
Регистры накопления
Общие требования к ведущим объектам
Вид регистра назначается в соответствии с проектной логикой.
Основная форма списка должна быть назначена обязательно, если предполагается работа с регистром в интерактивном
режиме.
Измерения регистров накопления
Сортировка: измерения регистров сведений в дереве метаданных сортируются в соответствии с проектной логикой.
Общие требования к имени, синониму, комментарию
Запрет пустых значений назначается в соответствии с проектной логикой.
Индексирование: индексировать следует только те измерения, по которым часто выполняются сортировка, отбор, поиск и т.
д. Все это будет работать и без индексирования, но медленнее. Индексирование снижает скорость записи и увеличивает объем базы.
Общие требования к типам
Ресурсы регистров накопления
Сортировка: ресурсы регистров сведений в дереве метаданных сортируются по имени в порядке возрастания.
Общие требования к имени, синониму, комментарию
Общие требования к типам
Реквизиты регистров накопления
Сортировка: реквизиты регистров сведений в дереве метаданных сортируются по имени в порядке возрастания.
Общие требования к имени, синониму, комментарию
Общие требования к типам
Формы регистров накопления
Общие требования к формам объектов
Макеты регистров накопления
Общие требования к макетам объектов