Пользовательские категории аудита
Подсистема аудита предоставляет фиксированный набор доступных категорий аудита. Этим категориям были назначены сообщения аудита, инициируемые событиями в ThingWorx Platform. Эти назначения нельзя изменить. Однако если требуется категория, которой нет в этом наборе, можно создать пользовательскую категорию и назначить этой категории пользовательские события и сообщения аудита.
Добавление пользовательской категории аудита с помощью таблицы локализации
Обе реализации подсистемы аудита предоставляют следующие способы добавления пользовательской категории аудита:
• Через таблицу локализации ThingWorx, измененную с помощью ThingWorx Composer.
• Создав новое расширение Java на стороне сервера для ThingWorx Platform. Сведения о создании пользовательской категории аудита с использованием пакета ThingWorx Java SDK для создания расширения с этой целью см. в разделе Создание пользовательских категорий аудита с помощью расширения. Этот метод все равно использует таблицы локализации, но создание лексем может быть программным или интерактивным в интерфейсе пользователя Composer, как здесь описано.
В этом разделе объясняется, как добавить пользовательскую категорию на стороне ThingWorx Platform через интерфейс пользователя таблиц локализации. Если вы никогда не работали с таблицами локализации ThingWorx, потратьте какое-то время на чтение раздела Таблицы локализации в этом справочном центре.
В случае готовности выполните следующие шаги, чтобы добавить пользовательскую категорию аудита в таблицы локализации.
1. Войдите в ThingWorx Composer и щелкните 
(Обзор).
(Обзор).2. В разделе Система на панели навигации Обзор выберите Таблицы локализации, как показано на следующем рисунке.
Откроется список "Таблицы локализации".
3. Установите флажок для таблицы локализации по умолчанию и, когда она станет активной, нажмите кнопку Править, чтобы открыть эту таблицу в режиме правки, как показано здесь:
Страница "Лексемы локализации" для таблицы локализации по умолчанию отображается в режиме правки:
4. Как показано на следующем рисунке, щелкните значок плюса (+) Добавить, чтобы добавить лексему локализации для пользовательской категории аудита:
На правой стороне экрана появится страница Новая лексема локализации.
5. В поле Имя сначала необходимо ввести префикс для лексемы локализации категории аудита audit.AuditCategory., а затем ввести уникальное наименование. Наименования, используемые для пользовательских категорий, должны быть уникальными. Например, audit.AuditCategory.CustomAlertCategory.
 | При условии, что лексема действительна, сервисы QueryAuditHistory и QueryAuditHistoryWithQueryCriteria возвращают пользовательские сообщения аудита с префиксом или без него. Однако если префикс не используется, подсистема не может различать лексемы категорий аудита и другие лексемы. Кроме того, чтобы подсистема аудита отображала пользовательскую категорию аудита в списке категорий в интерфейсе пользователя журнал аудита, каждая пользовательская категория аудита должна использовать префикс audit.AuditCategory.. |
6. В поле Значение лексемы можно использовать любое подходящее значение для категории. Например, используйте часть наименования, введенного после префикса. Можно также использовать любые алфавитно-цифровые символы, пробелы и символы подчеркивания.
Обратите внимание, что Значение лексемы становится Ссылочным значением для этой лексемы в таблицах локализации для других языков.
7. Чтобы сохранить эту лексему локализации, а затем создать лексему локализации для сообщения аудита, щелкните 
и переходите к следующему шагу. Если вы хотите остановить здесь, щелкните 
, чтобы сохранить и закрыть страницу.
и переходите к следующему шагу. Если вы хотите остановить здесь, щелкните , чтобы сохранить и закрыть страницу. | При запросе без определения этой лексемы локализации в других таблицах локализации сервис запросов возвращает только то, что было создано вами. После добавления лексемы в другие таблицы локализации результаты могут включать в себя другие языки. Если не определена лексема для пользовательского сообщения аудита, запрос не сможет найти его. |
Затем в таблицу локализации по умолчанию вы должны добавить лексему локализации для пользовательского сообщения аудита.
8. Если вы закрыли ее, нажмите кнопку +Добавить, чтобы снова отобразить страницу "Новая лексема локализации". В противном случае перейдите к следующему шагу.
9. В поле Наименование лексемы введите уникальный префикс и уникальное наименование для лексемы пользовательского сообщения аудита. Не используйте сочетание audit.AuditCategory для префикса. Имена пользовательских сообщений аудита должны быть уникальными. Например, myCustomAlertMessages.AlertEvent.
| | Префикс audit.AuditCategory зарезервирован только для категорий. Если этот префикс используется для сообщения, сообщение может быть интерпретировано как категория и отображаться в интерфейсе пользователя журнала аудита как категория, а не как сообщение. |
Для пользовательского сообщения аудита требуется дополнительная информация, недоступная в интерфейсе пользователя ThingWorx. Эта информация является аргументами пользовательского сообщения аудита. Например, аргументами могут быть thingName и alertEventMsg с примерами значений mixer123 и overflow. Можно указать такие аргументы в опции Значение лексемы для сообщения. Значения подставляются при генерации пользовательского сообщения аудита и возвращаются запросом аудита. Для простых сообщений, таких как "Импорт файла объекта завершен успешно", не требуется указывать какие-либо аргументы.
| | Дополнительные сведения о создании пользовательских событий см. в разделах Работа с событиями, предупреждениями и подписками и Документация ThingWorx API. |
10. В поле Значение лексемы добавьте аргументы для сообщения аудита. Каждый аргумент должен содержать два предшествующих и завершающих знака подчеркивания. Предположим, например, что пользовательское сообщение аудита для удаления сущности User имеет следующие аргументы:
◦ username
◦ entityType
◦ entityName
В поле Значение лексемы следует ввести:
User __username__ removed __entityType__ named '__entityName__'
Во время выполнения три аргумента заменяются, пока имеются соответствующие значения в аргументах пользовательских сообщений аудита.
 | Для некоторых сообщений не требуется использовать аргументы. Например, простые сообщения, такие как "Импорт файла объекта завершен успешно", не используют замену. |
11. Щелкните значок 
, чтобы сохранить и закрыть страницу.
, чтобы сохранить и закрыть страницу.12. Чтобы проверить добавление пользовательской категории и сообщения аудита, инициируйте событие, которое генерирует сообщение, а затем запустите сервис QueryAuditHistory или QueryAuditHistoryWithQueryCriteria, указав языковую настройку для возврата. Следует помнить, что для категории с сервисом QueryAuditHistoryWithQueryCriteria необходимо использовать лексему локализации.
Затем требуется добавить лексему локализации для пользовательской категории аудита и сообщения в таблицу локализации для каждой необходимой языковой настройки. Например, ja для японского языка или de для немецкого языка.
Выполните следующие действия.
1. Щелкните вкладку Обзор, чтобы вернуться к списку таблиц локализации, и выберите другую языковую настройку. В качестве примера выберите ja (японский) и щелкните Править, как показано ниже:
2. На странице лексемы локализации для языковой настройки ja найдите только что созданную лексему локализации для пользовательской категории аудита.
| | Чтобы быстро найти лексему, используйте Фильтр в верхней части списка. Начните вводить слово в наименование лексемы. Например, если в имени используется "MyCustom", начинайте ввод в поле фильтра, как показано ниже. Отображаются все лексемы локализации, содержащие это слово. |
3. Щелкните наименование пользовательской лексемы категории аудита, чтобы отобразить ее страницу правки на правой стороне вкладки, как показано на рисунке выше.
4. В поле Значение лексемы введите переведенное значение лексемы, которая использовалось для этой категории в языковой настройке по умолчанию.
5. Щелкните значок 
, чтобы сохранить и закрыть страницу правки.
, чтобы сохранить и закрыть страницу правки.6. В списке лексем локализации используйте Фильтр, чтобы найти наименование лексемы, созданной для пользовательского сообщения аудита в языковой настройке по умолчанию, и щелкните его, чтобы отобразить страницу правки с правой стороны вкладки.
7. В поле Значение лексемы добавьте переведенную часть сообщения и, если применимо, переведенные наименования аргументов для сообщения аудита. Как и в случае значения лексемы для языковой настройки по умолчанию, каждый аргумент долен начинаться и оканчиваться двумя символами подчеркивания.
8. Щелкните значок 
, чтобы сохранить и закрыть страницу правки.
, чтобы сохранить и закрыть страницу правки.9. Чтобы проверить добавление пользовательской категории и сообщения аудита, инициируйте событие, которое генерирует сообщение, а затем запустите сервис QueryAuditHistory или QueryAuditHistoryWithQueryCriteria, указав языковую настройку для возврата. Следует помнить, что для категории необходимо указать лексему локализации, а не наименование.
| | Используя интерфейс ThingWorx Java API, можно сделать все это в расширении. Вы создаете событие, для которого требуется аудит, а затем добавляете пользовательскую категорию аудита и пользовательское сообщение аудита в таблицы локализации по умолчанию для универсального английского языка, а затем в таблицу для любой другой требуемой языковой настройки. Можно также импортировать таблицу локализации в процессе импорта расширения. Дополнительные сведения о добавлении событий программным образом см. в подразделе Работа с событиями, предупреждениями и подписками в разделе "Оптимальные методы разработки приложений" в этом справочном центре. Необходимо также обратиться к документации Java для интерфейсов ThingWorx API Документация по API-интерфейсу. Дополнительные сведения об упаковке расширений с таблицами локализации см. в разделе Упаковка расширений вместе с таблицами локализации. |