AX 2012: Правила именования объектов

[sukhanchik]

Всем привет! Хотелось бы затронуть больную тему... В АХ 2012 были переписаны (в частности) финансы, в результате чего LedgerTrans "раскололась" на следующие таблички:

• GeneralJournalEntry
• GeneralJournalAccountEntry
• LedgerEntryJournal
• LedgerEntry
• SubledgerVoucherGeneralJournalEntry
• LedgerEntryJournalizing

С ходу возникает резонный вопрос - а каких правил придерживались разработчики объектов в АОТ в ходе их именования?
Раньше принцип существовал и был такой:
Сначала указывается префикс модуля
Затем указывается тип таблицы / иного объекта (может не указываться или могут быть иные варианты)
В конце указывается суффикс названия.

Например,
LedgerJournalTable:
Здесь:
Ledger - префикс модуля (варианты: Invent, Prod, Cust, Vend, smm и т.д.)
Journal - тип таблицы, указывающий на то, что это журнал
Table - суффикс таблицы, означающий, что эта таблица является либо шапкой журнала, либо справочником.

Т.о. выучив общий принцип именования таблиц - можно было не зная нюансы предположить, что в таблице CustTrans будут сидеть проводки по клиентам, LedgerTrans - проводки по ГК, а в InventTable - записи по номенклатурам (справочник).
Для классов - был суффикс Engine или Form, который тоже наталкивал на определенные мысли о его предназначении разработчика.

Понятно, что этот принцип было тяжело соблюдать и многие таблицы / классы этому правилу не соответствовали. Но база была. Более того - начало названия объекта все-таки так или иначе старалось соблюдаться - т.о. все объекты, относящиеся к одному модулю (Ledger, Invent) были сгруппированы в одном месте.

Теперь получается так, что объекты будут "размазаны" равномерно по АОТ - т.к. фиг догадаешься искать куски LedgerTrans среди объектов на литеру G (GeneralJournalEntry) или S (SubledgerVoucherGeneralJournalEntry). Также непонятно предназначение слова Entry. Оно как-то тоже бессистемно находится в середине или конце названия таблицы. Более того - как-то не вяжется слово Entry (ввод) с транзакционными таблицами (т.е. в которые не вводятся данные пользователем напрямую).

Вопрос к тем, кто может быть в курсе изменения политики именования объектов. Какие теперь существуют правила именования объектов и по какому принципу можно догадываться о предназначении того или иного объекта?

[oip]

Тоже обратил на это внимание... Не понравилось. Но по-крайней мере официально пока все осталось как было. Хотя и "this content is preliminary and subject to change". Видимо, пока все это просто копия BP из AX2009, а нового еще нет.

Цитата:

Best Practices for Table Properties [AX 2012]

Name:

Prefix with the module name. For example, Cust, Vend, or Invent.
Infix with a logical description of the contents. For example, CustCollectionLetterTrans, where CollectionLetter is the infix. For temporary tables, infix with Tmp. For example, CustTmpLedger.
Postfix with the type of contents. For example, Trans, Jour, Line, Table, Group, Parameters, or Setup.
The primary tables for the major business areas are postfixed with Table. For example, CustTable, InventTable, and VendTable.

http://msdn.microsoft.com/en-us/libr...(v=AX.60).aspx

[Alex_KD]

Подозреваю, что это только вершина айсберга.....и внутри еще много такого

[Ivanhoe]

Цитата:

Сообщение от sukhanchik

Также непонятно предназначение слова Entry. Оно как-то тоже бессистемно находится в середине или конце названия таблицы. Более того - как-то не вяжется слово Entry (ввод) с транзакционными таблицами (т.е. в которые не вводятся данные пользователем напрямую).

В данном контексте Entry, скорее, "запись", или "элемент, компонент".

[sukhanchik]

Цитата:

Сообщение от Ivanhoe

В данном контексте Entry, скорее, "запись", или "элемент, компонент".

Эммм... тоже как-то привыкаешь к некоторой терминологии. Я тоже с помощью http://translate.google.ru могу перевести "Поставщик" как "cateter" . Но как-то все привыкли к "vendor"

[lvan]

Мне кажется, что если в вышеуказанных таблицах добавить префикс Ledger, то их имена станут черезчур длинными.
Вот и всё объяснение.

[sukhanchik]

Цитата:

Сообщение от lvan

Мне кажется, что если в вышеуказанных таблицах добавить префикс Ledger, то их имена станут черезчур длинными.
Вот и всё объяснение.

Цитата:

Сообщение от sukhanchik

• GeneralJournalEntry
• GeneralJournalAccountEntry
• LedgerEntryJournal
• LedgerEntry
• SubledgerVoucherGeneralJournalEntry
• LedgerEntryJournalizing

Не... это не объяснение для разработчиков.
Во-первых есть табличка Subledger..., в которой фраза Ledger уже присутствует. И ничто не мешало поставить фразу в начало.
Во-вторых также ничто не мешало называть табличку, уже отталкиваясь от того, что начинается она с фразы Ledger. И уже ограничивать максимально допустимое название таблицы исходя из того, что часть букв уже зарезервирована под фразу Ledger.
В-третьих, хоть это и менее критично - но хаотичное расположение фразы Entry в названиях таблиц мне тоже не нравится.
В-четвертых из названия таблиц не совсем прослеживается их предназначение. К примеру - таблицы LedgerEntryJournal и LedgerEntryJournalizing по моим понятиям называются одинаково - т.к. у них основы фраз одинаковы и разница в именах не смысловая (аналогично, если были бы 2 таблицы: CustTable и CustomerTable). Плюс табличка GeneralJournalEntry тоже "просится" в плане названия к этим двум.

[lvan]

LedgerSub чтоли?
вообще по названиям гадать о предназначении не нужно
сделали ведь DeveloperDocumentation property

[sukhanchik]

Цитата:

Сообщение от lvan

LedgerSub чтоли?

Ну а почему бы и нет? Никто же не претендует на "некорявость" названия. А вот группировка в АОТе "рядом стоящих" объектов не помешала бы.
На худой конец "LedgerSubLedger...", а остальную часть названия - как-то сократить / преобразовать.

[Михаил Андреев]

Цитата:

Сообщение от Ivanhoe

В данном контексте Entry, скорее, "запись", или "элемент, компонент".

Термин "entry" (точнее, фраза "journal entry") обычно обозначает запись журнала в учёте. Это касается как бухгалтерских проводок, так и всех остальных, например, складских.

ИМХО, Entry заменило слово Trans для журналов. По первым примерам похоже...
Но почему пишут то JournalEntry, то EntryJournal, вот это непонятно.

Оттуда же, похоже, "ноги растут" и для префикса SubLedger. Это, видимо, модульный журнал. Но название SubledgerVoucherGeneralJournalEntry меня вогнало в ступор Если отвлечься от AX, получается по кускам фраза типа "запись журнала ГК по ваучеру модульного журнала" или что-то в этом роде.

Короче, надо документацию искать. Наверняка, это описано где-то.

[mazzy]

Цитата:

Сообщение от sukhanchik

Вопрос к тем, кто может быть в курсе изменения политики именования объектов. Какие теперь существуют правила именования объектов и по какому принципу можно догадываться о предназначении того или иного объекта?

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

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

[gl00mie]

Да, в конце концов, ничто не помешало, например, на ряду с InventItemPurchSetup и InventItemSalesSetup сделать InventItemInventSetup.

[sukhanchik]

Цитата:

Сообщение от Михаил Андреев

Термин "entry" (точнее, фраза "journal entry") обычно обозначает запись журнала в учёте. Это касается как бухгалтерских проводок, так и всех остальных, например, складских.
ИМХО, Entry заменило слово Trans для журналов.

Ок, я не против смены терминов - лишь бы они были заменены везде .

Цитата:

Сообщение от Михаил Андреев

Короче, надо документацию искать. Наверняка, это описано где-то.

А вот тут я категорически возражаю . Ну не было в природе такой документации по 3.0 (не считая конечно красивых файликов по локализации, которые рисовал EVGL). И это не мешало разбираться в системе. А теперь получается - что без документации - мешает.

Цитата:

Сообщение от mazzy

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

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

А вот это увы четко прослеживается . Я просто думал (в душе надеялся), что люди, которые плохо знают функционал предыдущих версий все-таки будут стараться изобрести некую свою систему именования. Пусть заменят Trans на Entry. Пусть еще что-нибудь заменят. Но оставят (или придумают свой) принцип именования объектов. Важно! Который бы был и которому бы придерживались. Ведь смогли разработчики еще тогда аксапты (в далеком 19хх году) внедрить такой принцип при построении системы - чем разработчики в МС хуже?

[Raven Melancholic]

Интересно, в данном ключе насколько могут измениться доводы приверженцев того или иного подхода из темы:
Префиксы-суффиксы. Как лучше? Стоит ли избавляться от них?

[Ivanhoe]

Цитата:

Сообщение от sukhanchik

Эммм... тоже как-то привыкаешь к некоторой терминологии. Я тоже с помощью http://translate.google.ru могу перевести "Поставщик" как "cateter" . Но как-то все привыкли к "vendor"

Для меня слово "entry" вполне органично в данном контексте и без словаря (язык изучался углубленно с первого класса).

Цитата:

Сообщение от Михаил Андреев

Термин "entry" (точнее, фраза "journal entry") обычно обозначает запись журнала в учёте. Это касается как бухгалтерских проводок, так и всех остальных, например, складских.

ИМХО, Entry заменило слово Trans для журналов. По первым примерам похоже...
Но почему пишут то JournalEntry, то EntryJournal, вот это непонятно.

Согласен, скорее это замена "trans", который, в общем-то, в итоге перерос просто "проводку" / "транзакцию".

А порядок слов может быть важным. Если "entry" в конце - то скорее всего это таблица записей "того, что было до entry", а вот "хххEntryJournal" скорее означает журнал записей "ххх" Хотя AX2012 я еще в глаза не видел, возможно, не прав

[sukhanchik]

Цитата:

Сообщение от Ivanhoe

А порядок слов может быть важным. Если "entry" в конце - то скорее всего это таблица записей "того, что было до entry", а вот "хххEntryJournal" скорее означает журнал записей "ххх" Хотя AX2012 я еще в глаза не видел, возможно, не прав

Я тоже АХ2012 еще в глаза не видел - сужу пока только по докам .
Но мысль в отношении важности порядка слов - интересная. Посмотрим - что будет на выходе.

[George Nordic]

Цитата:

Сообщение от mazzy

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

Сергей. Разработчики могут называть объекты, как им заблагорассудится. На то и ставят ведущих, которые обучают новичков и контролируют качество кода и соблюдение BestPractises. А когда дело касается столь существенных изменений, то всем заправляет Архитектор Системы - именно он отвечает за правильную работу всей функциональности, корректность взаимосвязей и т.п. И я не верю, что на таком уровне может твориться подобный бардак. Или так было задуманно специально, и последуют изменения ВР в части именования объектов, или дело не в разработчиках, а в архитекторах. Но это было бы крайне печально....

С Уважением,
Георгий

[mazzy]

Цитата:

Сообщение от George Nordic

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

Могут.
А я - верю.
Если сделано специально, то какой смысл в ТАКОМ изменении?

[Ivanhoe]

Покопавшись в коде оповещений, workflow, адресов и глобальной адресной книги в AX 2009, я тоже уже не верю в "Архитекторов Системы" )

[oip]

Пока есть только такие описания:

Цитата:

Сообщение от Ivanhoe

А порядок слов может быть важным. Если "entry" в конце - то скорее всего это таблица записей "того, что было до entry", а вот "хххEntryJournal" скорее означает журнал записей "ххх" Хотя AX2012 я еще в глаза не видел, возможно, не прав

Цитата:

The LedgerEntryJournal table contains the journal group information.

http://msdn.microsoft.com/en-us/libr...(v=AX.60).aspx

Цитата:

The GeneralJournalEntry table contains the general journal header information.

http://msdn.microsoft.com/en-us/libr...(v=AX.60).aspx

Цитата:

Сообщение от Михаил Андреев

Оттуда же, похоже, "ноги растут" и для префикса SubLedger. Это, видимо, модульный журнал. Но название SubledgerVoucherGeneralJournalEntry меня вогнало в ступор Если отвлечься от AX, получается по кускам фраза типа "запись журнала ГК по ваучеру модульного журнала" или что-то в этом роде.

Короче, надо документацию искать. Наверняка, это описано где-то.

Цитата:

The SubledgerVoucherGeneralJournalEntry table holds the relationship of a voucher to a general journal entry.

http://msdn.microsoft.com/en-us/libr...(v=AX.60).aspx