Перейти к основному содержимому

Создание атрибута класса

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

Чтобы создать атрибут класса:

  1. В проекте выберите файл DataModel.mdmodel.

  2. На боковой панели нажмите значок UG_settings_icon.png и выберите раздел Классы.

  3. В списке классов выберите класс, в котором вы хотите добавить атрибут.

    В правой части рабочей области отображается подробная информация о выбранном классе. Вкладка Атрибуты выбрана по умолчанию.

  4. Справа от имени вкладки Атрибуты нажмите +.

  5. В окне Атрибут, которое открывается, укажите следующие параметры:

    • Имя (обязательный параметр): введите имя атрибута. Вы можете использовать буквы русского и латинского алфавита и цифры. Имя атрибута используется для отображения в DevTools и не используется для именования сущностей в базе данных, которая будет создана согласно выбранной модели данных.

    • Описание (необязательный параметр): введите описание атрибута. Вы можете использовать любые символы.

    • Псевдоним (обязательный параметр): введите псевдоним атрибута. Псевдоним будет использоваться для именования атрибута в GraphQL-типах.

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

      • используйте латинские буквы, цифры и знак подчеркивания;
      • не используйте цифру в качестве первого символа;
      • вводите строку длиной не более 63 символов;
      • не используйте системные имена C#.

    • Тип атрибута (обязательный параметр): из раскрывающегося списка выберите один из следующих типов атрибута и укажите дополнительные параметры, соответствующие выбранному типу атрибута:

      • boolean: выберите для хранения какого-либо признака, например, принадлежности или наличия и укажите следующие параметры:

        • Значение по умолчанию: установите флажок, если вы хотите по умолчанию присвоить этому атрибуту значение true. Если вы не установите флажок, атрибуту будет присвоено значение false.
        • Обязательное значение: установите флажок, если вы хотите, чтобы параметр Значение по умолчанию был обязательным. По умолчанию флажок снят, что означает, что параметр Значение по умолчанию не является обязательным.
      • string: выберите для хранения фрагмента текста и укажите следующие параметры:

        • Значение по умолчанию: значение, которое будет присвоено атрибуту, если значение атрибута не будет указано при вводе.
        • Обязательное значение: установите флажок, если вы хотите, чтобы параметр Значение по умолчанию был обязательным. По умолчанию флажок снят, что означает, что параметр Значение по умолчанию не является обязательным.
        • Индексация для полнотекстового поиска: установите флажок, если вы хотите, чтобы значение атрибута было проиндексировано с целью дальнейшего использования при полнотекстовом поиске.
        • Значение может быть неопределенным: установите флажок, если вы хотите разрешить запись значения NULL в качестве значения этого атрибута.

        • Записывать идентификатор пользователя: включите переключатель, если вы хотите записывать идентификатор пользователя разработанного приложения в качестве значения этого атрибута.

        • в блоке Длина строки укажите следующие параметры:

          • От (необязательный параметр): минимальная длина строки, которую можно ввести в качестве значения этого атрибута. Минимальная длина строки может составлять ноль символов, есть строка может быть пустой.
          • До (необязательный параметр): максимальная длина строки, которую можно ввести в качестве значения этого атрибута. Максимальная длина строки может составлять 10485760 символов.

          Если вы не укажете значения параметров От и До, по умолчанию максимальная длина строки будет составлять 255 символов.

        • Регулярное выражение (необязательный параметр): введите шаблон для строки. Например, вы можете использовать следующие шаблоны:

          • ^((\+?7|8)[ \-] ?)?((\(\d{3}\))|(\d{3}))?([ \-])?(\d{3}[\- ]?\d{2}[\- ]?\d{2})$ для российского номера телефона;
          • /[-a-zA-Z0-9@:%_\+.~#?&//=]{2,256}\.[a-z]{2,4}\b(\/[-a-zA-Z0-9@:%_\+.~#?&//=]*)?/gi для URL-адреса.
      • text: выберите для хранения фрагмента текста неограниченной длины более 10485760 символов и укажите следующие параметры:

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

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

        • Значение по умолчанию: значение, которое будет присвоено атрибуту, если значение атрибута не будет указано при вводе.
        • Обязательное значение: установите флажок, если вы хотите, чтобы параметр Значение по умолчанию был обязательным. По умолчанию флажок снят, что означает, что параметр Значение по умолчанию не является обязательным.

        • Значение может быть неопределенным: установите флажок, если вы хотите разрешить запись значения NULL в качестве значения этого атрибута.

        • в блоке Диапазон значений укажите следующие параметры:
          • От (необязательный параметр): минимальное число, которое можно будет ввести в качестве значения этого атрибута.
          • До (необязательный параметр): максимальное число, которое можно будет ввести в качестве значения этого атрибута.

        Если вы не укажете значения параметров От и До, по умолчанию в качестве значения атрибута, можно будет хранить число в диапазоне от -2147483648 до +2147483647.

      • long: выберите для хранения числового значения со знаком и укажите следующие параметры:

        • Значение по умолчанию: значение, которое будет присвоено атрибуту, если значение атрибута не будет указано при вводе.
        • Обязательное значение: установите флажок, если вы хотите, чтобы параметр Значение по умолчанию был обязательным. По умолчанию флажок снят, что означает, что параметр Значение по умолчанию не является обязательным.
        • Значение может быть неопределенным: установите флажок, если вы хотите разрешить запись значения NULL в качестве значения этого атрибута.

        • в блоке Диапазон значений укажите следующие параметры:
          • От (необязательный параметр): минимальное число, которое можно будет ввести в качестве значения этого атрибута.
          • До (необязательный параметр): максимальное число, которое можно будет ввести в качестве значения этого атрибута.

        Если вы не укажете значения параметров От и До, по умолчанию в качестве значения атрибута, можно будет хранить число в диапазоне от -9223372036854775808 до +9223372036854775807.

      • double: выберите для хранения числа с плавающей запятой с двойной точностью и укажите следующие параметры:

        • Значение по умолчанию: значение, которое будет присвоено атрибуту, если значение атрибута не будет указано при вводе.
        • Обязательное значение: установите флажок, если вы хотите, чтобы параметр Значение по умолчанию был обязательным. По умолчанию флажок снят, что означает, что параметр Значение по умолчанию не является обязательным.
        • Значение может быть неопределенным: установите флажок, если вы хотите разрешить запись значения NULL в качестве значения этого атрибута.

        • Десятичных знаков (обязательный параметр): количество десятичных знаков числа. Вы можете указать до 15 знаков.

        • в блоке Диапазон значений укажите следующие параметры:
          • От (необязательный параметр): минимальное число, которое можно будет ввести в качестве значения этого атрибута.
          • До (необязательный параметр): максимальное число, которое можно будет ввести в качестве значения этого атрибута.

        Если вы не укажете значения параметров От и До, по умолчанию в качестве значения атрибута, можно будет хранить число в диапазоне от -$10^{307}$ до +$10^{308}$.

      • dateTime: выберите для хранения даты и времени и укажите следующие параметры:

        • Дата: включите переключатель, если вы хотите хранить только дату.
        • Дата и время: включите переключатель, если вы хотите хранить дату и время.

        • Значение по умолчанию: значение, которое будет присвоено атрибуту, если значение атрибута не будет указано при вводе.
        • Обязательное значение: установите флажок, если вы хотите, чтобы параметр Значение по умолчанию был обязательным. По умолчанию флажок снят, что означает, что параметр Значение по умолчанию не является обязательным.
        • Значение может быть неопределенным: установите флажок, если вы хотите разрешить запись значения NULL в качестве значения этого атрибута.

        • Tекущее время (необязательный параметр): включите переключатель, если вы хотите в качестве значения этого атрибута записывать текущую системную метку времени, содержащую год, месяц, день, час, минуты и секунды, используя локальный часовой пояс. Этот параметр атрибута может использоваться, если в разрабатываемом приложении нужно фиксировать, например, момент создания заказа или момент изменения статуса заказа.
        • Игнорировать временную зону: установите флажок, если вы хотите хранить значение атрибута согласно стандарту UTC.
      • enum: выберите для хранения одного из значений ранее созданного перечисления и укажите следующие параметры:

        • Перечисление (обязательный параметр): из раскрывающегося списка выберите имя перечисления, созданного в текущем экземпляре Платформы.

        • Значение по умолчанию: значение, которое будет присвоено атрибуту, если значение атрибута не будет указано при вводе.
        • Обязательное значение: установите флажок, если вы хотите, чтобы параметр Значение по умолчанию был обязательным. По умолчанию флажок снят, что означает, что параметр Значение по умолчанию не является обязательным.

      • MLString: выберите для хранения локализованных значений атрибута в зависимости от локали браузера, в котором будет запущено разработанное приложение.

      • Money: выберите для хранения денежных величин и укажите следующие параметры:

        • Значение по умолчанию: значение, которое будет присвоено атрибуту, если значение атрибута не будет указано при вводе.
        • Обязательное значение: установите флажок, если вы хотите, чтобы параметр Значение по умолчанию был обязательным. По умолчанию флажок снят, что означает, что параметр Значение по умолчанию не является обязательным.

        • в блоке Диапазон значений укажите следующие параметры:
          • От (необязательный параметр): минимальное число, которое можно будет ввести в качестве значения этого атрибута.
          • До (необязательный параметр): максимальное число, которое можно будет ввести в качестве значения этого атрибута.

        Если вы не укажете значения параметров От и До, по умолчанию в качестве значения атрибута можно будет хранить число в диапазоне от -10^38 + 1 до 10^38 - 1.

      • guid: выберите для присваивания и хранения уникальных значений в виде 128-битного идентификатора. Вы можете использовать этот тип, например, для хранения кодов изделий. Укажите следующие параметры:

        • Значение по умолчанию: значение, которое будет присвоено атрибуту, если значение атрибута не будет указано при вводе.
        • Обязательное значение: установите флажок, если вы хотите, чтобы параметр Значение по умолчанию был обязательным. По умолчанию флажок снят, что означает, что параметр Значение по умолчанию не является обязательным.

      • <имя пользовательского типа>: выберите для хранения значения пользовательского типа, который вы определили в модели данных проекта.

      • array: выберите для хранения массива значений и укажите следующие параметры:

        • Тип данных элементов (обязательный параметр): по аналогии с раскрывающимся списком для параметра Тип атрибута (см. описание выше) выберите значение из раскрывающегося списка. Список содержит те же типы, что и типы атрибутов, за исключением MLString.
        • дополнительные параметры, соответствующие выбранному типу данных элемента массива: заполните параметры, руководствуясь инструкциями (см. описание выше) по заполнению параметров типов атрибутов.
  6. Нажмите Создать.

    Окно Атрибут закрывается.

Созданный атрибут класса отображается в области подробной информации о классе. Теперь на основе созданных атрибутов вы можете создавать индексы и/или связывать классы.