Класс

Этот контекст предоставляет вам доступ и управление одним классом и его экземплярами.

Уникальные действия

[?]

Настроить

Данное действие Настроить используется для редактирования свойств класса.

Изменение имени класса не разрешено.

Тип действия:

Настроить

Общие действия

[?]

Удалить, Копировать, Реплицировать, Редактировать права доступа к контенту, Просмотр событий, Показать статус

Состояния и иконки контекста

Контекст имеет только одно состояние. Он всегда представлен иконкой .

Дополнительная информация

Информация о контексте

Тип контекста: class

Имя контекста: предоставляется пользователем

Описание контекста: предоставляется пользователем

Путь контекста: users.USER_NAME.classes.CLASS_NAME

Маска контекста: users.*.classes.*

Права доступа к контексту

[?]

Уровень

Описание

Отсутствует

Нет доступа.

Наблюдатель

Управление экземпляром класса.

Просмотр конфигурации.

Мониторинг основных событий.

Просмотр статуса.

Оператор

Те же, что у Наблюдателя.

Менеджер

Удаление класса.

Инженер

Те же, что у Менеджера.

Администратор

Настройка класса.

Общие переменные (свойства)

[?]

Общие переменные: groupMembership (Group Membership), validity (Validity), activeAlerts (Active Alerts)

Свойства

Смотрите описание переменной и ее полей здесь.

Имя переменной:

childInfo

Записи:

1

Права доступа:

Доступно для чтения на уровне прав доступа Наблюдатель, доступно для записи на уровне прав доступа Менеджер

Формат записи:

Имя поля

Тип поля

Примечания

name

String

1 - 50 символов

description

String

1 - 50 символов

namingExpression

String


storageContext

String


normalConcurrentBindings

Integer


maximumConcurrentBindings

Integer


maximumBindingQueueLength

Integer


normalConcurrentInstanceBindings

Integer


maximumConcurrentInstanceBindings

Integer


maximumInstanceBindingQueueLength

Integer


Поля

Смотрите описание переменной и ее полей здесь.

Имя переменной:

fields

Записи:

0...не ограничено

Права доступа:

Доступно для чтения на уровне прав доступа Наблюдатель, доступно для записи на уровне прав доступа Администратор

Формат записи:

Имя поля

Тип поля

Примечания

name

String


type

String


description

String


defaultValue

String


readonly

Boolean


nullable

Boolean


key

Boolean


selvals

Data Table


extselvals

Boolean


hidden

Boolean


inline

Boolean


encrypted

Boolean


help

String


editor

String


editorOptions

Data Table


group

String


primaryKey

Boolean


length

Integer


Отношения многие ко многим

Смотрите описание переменной и ее полей здесь.

Имя переменной:

manyToManyRelations

Записи:

0...не ограничено

Права доступа:

Доступно для чтения на уровне прав доступа Наблюдатель, доступно для записи на уровне прав доступа Администратор

Формат записи:

Имя поля

Тип поля

Примечания

name

String


description

String


relatedClass

String


cascadeDelete

Boolean


Жизненные циклы

Смотрите описание переменной и ее полей здесь.

Имя переменной:

lifecycles

Записи:

0...не ограничено

Права доступа:

Доступно для чтения на уровне прав доступа Наблюдатель, доступно для записи на уровне прав доступа Администратор

Формат записи:

Имя поля

Тип поля

Примечания

name

String


description

String


states

Data Table


stateTransitions

Data Table


Просмотры

Смотрите описание переменной и ее полей здесь.

Имя переменной:

views

Записи:

0...не ограничено

Права доступа:

Доступно для чтения на уровне прав доступа Наблюдатель, доступно для записи на уровне прав доступа Администратор

Формат записи:

Имя поля

Тип поля

Примечания

name

String


description

String


columns

Data Table


filter

Data Table


sorting

Data Table


Привязки

Переменная содержит привязки класса. Каждая строка позволяет обновить целевое поле в соответствии с результатами вычисления выражения.

Имя переменной:

bindings

Записи:

0...не ограничено

Права доступа:

Доступно для чтения на уровне прав доступа Наблюдатель, доступно для записи на уровне прав доступа Менеджер

Формат записи:

Имя поля

Тип поля

Примечания

target

String

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

expression

String

Выражение, которое вычисляется при активации привязки.

Среда вычисления выражения:

Контекст по умолчанию

Контекст текущего экземпляра класса.

Таблица данных по умолчанию

Нет

Ряд по умолчанию

0

Переменные среды

Только стандартные переменные.

Общие функции

[?]

Открыть хранилище

Открыть сессию хранилища.

Имя функции:

storageOpen

Права доступа:

Доступно на уровне прав доступа Наблюдатель

Записи ввода:

1

Формат ввода:

Имя

Тип

Описание

id

Long

Идентификатор сессии хранилища

view

String

Имя отображения класса

query

String

Строка запроса

table

String

Имя таблицы

columns

DataTable

Таблица с настройками колонок. Те же поля, что и в таблице колонок, описанных в Представлениях

filter

DataTable

Фильтры экземпляров используются при значении null параметра id.

processCalculatedFields

Boolean

При значении True этот параметр позволяет применять функцию smartFilterExpression к вычислимым полям. При значении False фильтры не будут влиять на вычислимые поля.

sorting

DataTable

Таблица с настройками сортировки. Те же поля, что и в таблице сортировки экземпляра, описанные в Представлениях

getData

Boolean

Определяет следует ли открывать сессию или просто вернуть данные

limit

Integer

Максимальное количество возвращаемых экземпляров

offSet

Integer

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

Записи вывода:

1

Формат вывода:

Имя

Тип

Описание

id

Long

Идентификатор сессии хранилища

count

Integer

Количество полученных экземпляров

data

DataTable

Содержит таблицу с полученными экземплярами, если параметр getData равен true

Закрыть хранилище

Закрыть сессию хранилища.

Имя функции:

storageClose

Права доступа:

Доступно на уровне прав доступа Наблюдатель

Записи ввода:

1

Формат ввода:

Имя

Тип

Описание

id

Long

Идентификатор сессии хранилища

Записи вывода:

0

Формат вывода:

Нет

Получить данные

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

Имя функции:

storageGet

Права доступа:

Доступно на уровне прав доступа Наблюдатель

Записи ввода:

1

Формат ввода:

Имя

Тип

Описание

id

Long

Идентификатор сессии хранилища

first

Integer

Порядковый номер первого из получаемых экземпляров

count

Integer

Количество получаемых экземпляров

processCalculatedFields

Boolean

При значении True этот параметр позволяет применять фильтры к вычислимым полям. При значении False фильтры не влияют навычислимые поля.

Записи вывода:

1

Формат вывода:

Имя

Тип

Описание

size

Integer

Количество полученных экземпляров

data

DataTable

Таблица с полученными экземплярами

Обновить данные

Обновить экземпляры в конкретной сессии или в соответствии с фильтром.

Имя функции:

storageUpdate

Права доступа:

Доступно на уровне прав доступа Наблюдатель

Записи ввода:

0...не ограничено

Формат ввода:

Имя

Тип

Описание

id

Long

Идентификатор сессии хранилища

row

Integer

Номер строки, которую необходимо изменить. Используется, если параметр id не равен null

column

String

Имя колонки, которую необходимо изменить.

value

DataTable

Новое выставляемое значение, представленное в виде таблицы данных с одним полем "value" и одной строкой, содержащей целевое значение

table

String

Имя таблицы. Используется, если параметр id равен null

filter

DataTable

Фильтры экземпляров . Используется, если параметр id равен null

Записи вывода:

1

Формат вывода:

Имя

Тип

Описание

count

Integer

Количество затрагиваемых записей.

Удалить данные

Удалить экземпляры в конкретной сессии или в соответствии с фильтром.

Имя функции:

storageDelete

Права доступа:

Доступно на уровне с правами доступа для Наблюдателя

Записи ввода:

1

Формат ввода:

Имя

Тип

Описание

id

Long

Идентификатор сессии хранилища

rowList

DataTable

Список строчек, которые необходимо удалить. Используется, если параметр id не равен null

table

String

Имя таблицы. Используется, если параметр id равен null

filter

DataTable

Фильтры экземпляров . Используется, если параметр id равен null

Записи вывода:

1

Формат вывода:

Имя

Тип

Описание

count

Integer

Количество затрагиваемых записей.

Добавить данные

Добавить новые экземпляры в сессию или по имени таблицы.

Имя функции:

storageInsert

Права доступа:

Доступно на уровне с правами доступа для Наблюдателя

Записи ввода:

1

Формат ввода:

Имя

Тип

Описание

id

Long

Идентификатор сессии хранилища

values

DataTable

Таблица, содержащая добавляемые экземпляры

table

String

Имя таблицы. Используется, если параметр id равен null

Записи вывода:

0...не ограничено

Формат вывода:

Имя

Тип

Описание

instanceId

String

Идентификатор добавленного экземпляра

Связать экземпляры

Связать экземпляры отношением многие-ко-многим.

Имя функции:

storageLinkInstance

Права доступа:

Доступно на уровне прав доступа Наблюдатель

Записи ввода:

1

Формат ввода:

Имя

Тип

Описание

table

String

Имя таблицы

relatedTable

String

Имя связанной таблицы

relationName

String

Имя отношения

relatedIds

DataTable

Таблица с парами идентификаторов экземпляров, которые необходимо связать.

Записи вывода:

0

Формат вывода:

Нет

Разъединить экземпляры

Разъединить связанные экземпляры отношением многие-ко-многим.

Имя функции:

storageUnlinkInstance

Права доступа:

Доступно на уровне прав доступа Наблюдатель

Записи ввода:

1

Формат ввода:

Имя

Тип

Описание

table

String

Имя таблицы

relatedTable

String

Имя связанной таблицы

relationName

String

Имя отношения

relatedIds

DataTable

Таблица с парами идентификаторов экземпляров, которые необходимо разъединить.

Записи вывода:

0

Формат вывода:

Нет

Получить формат данных

Возвращает пустую таблицу с форматом, который соответствует формату класса и представления (если оно задано).

Имя функции:

getFormat

Права доступа:

Доступно на уровне с правами доступа для Наблюдателя

Записи ввода:

1

Формат ввода:

Имя

Тип

Описание

table

String

Не используется в контексте класса

view

String

Имя представления класса

Записи вывода:

0...не ограничено

Формат вывода:

Динамический

Обработать привязки

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

Имя функции:

processBindings

Права доступа:

Доступно на уровне прав доступа Наблюдатель

Записи ввода:

0…не ограничено

Формат ввода:

Таблица фильтров из представления класса.

Имя

Тип

Описание

logical

Integer

Логическая операция, (0) для первой записи, (1) для AND или (2) для OR.

type

Integer

Условие (0) или подусловие (1).

column

String

Имя поля класса, которое необходимо отфильтровать.

operation

String

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

value

String

Значение, с которым сравнивается поле.

nested

String

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

Записи вывода:

0

Формат вывода:

Нет

Подготовить фильтр

Принимает в качестве аргументов свойства Фильтров экземпляров и возвращает таблицу фильтров экземпляров, подходящую для использования в качестве параметра filter функций Open Storage, Update Data и Delete Data.

Имя функции:

prepareFilter

Права доступа:

Доступно на уровне прав доступа Наблюдатель

Записи ввода:

0...не ограничено

Формат ввода:

Соответствует формату Фильтра экземпляров :

имя

Тип

Описание

logical

Integer

Логическая операция, (0) для первой записи, (1) для AND или (2) для OR.

type

Integer

Условие (0) или подусловие (1).

column

String

Имя поля класса, которое необходимо отфильтровать.

operation

String

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

value

String

Значение, с которым сравнивается поле.

nested

String

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

Записи вывода:

0...не ограничено

Формат вывода:

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

Общие события

[?]

Общие события: info (Информация)

Создан экземпляр класса

Это событие формируется каждый раз, когда создается экземпляр класса.

Имя события:

classInstanceCreated

Права доступа:

Доступно на уровне прав доступа Наблюдатель

Период действия:

Не сохраняется

Записи:

0...не ограничено

Формат записи:

Имя поля

Тип поля

Примечания

instanceId

String

ID нового экземпляра.

instanceDescription

String

Удобное для чтения описание нового экземпляра.

modificationAuthor

String

Имя пользователя, который создал экземпляр.

Изменен экземпляр класса

Это событие формируется, когда редактируется одно или более поле экземпляра класса.

Имя события:

classInstanceChanged

Права доступа:

Доступно на уровне с правами доступа для Наблюдателя

Период действия:

Не сохраняется

Записи:

0...не ограничено

Формат записи:

Имя поля

Тип поля

Примечания

instanceId

String

ID измененного экземпляра.

instanceDescription

String

Удобное для чтения описание измененного экземпляра.

modificationAuthor

String

Имя пользователя, который инициировал изменение.

fieldName

String

Имя измененного поля.

fieldDescription

String

Описание измененного поля.

oldValue

String

Значене старого поля, преобразованного в строку.

newValue

String

Значене нового поля, преобразованного в строку.

Удален экземпляр класса

Это событие формируется каждый раз, когда удален экземпляр класса.

Имя события:

classInstanceDeleted

Права доступа:

Доступно на уровне с правами доступа для Наблюдателя

Период действия:

Не сохраняется

Записи:

0...не ограничено

Формат записи:

Имя поля

Тип поля

Примечания

instanceId

String

ID удаленного экземпляра.

instanceDescription

String

Удобное для чтения описание удаленного экземпляра.

modificationAuthor

String

Имя пользователя, который удалил экземпляр.

instance

DataTable

Таблица, содержащая значения полей удаленного экземпляра класса.

Откомментирован экземпляр класса

Это событие формируется, когда к экземпляру класса добавляется комментарий.

Имя события:

classInstanceCommented

Права доступа:

Доступно на уровне с правами доступа для Менеджера

Период действия:

Не сохраняется

Записи:

0...не ограничено

Формат записи:

Имя поля

Тип поля

Примечания

instanceId

String

ID комментируемого экземпляра.

instanceDescription

String

Удобное для чтения описание комментируемого экземпляра

author

String

Имя пользователя, который добавил комментарий.

comment

String

Текст комментария.