TM SDK Documentation 3.1.0
Дерево страниц

Плагин представляет собой архив в формате .zip. В состав архива входят:

  • папка licenses, содержащая файлы лицензий;
  • папка icon, содержащая файлы с используемыми пиктограммами для регистрируемых событий;
  • файл manifest.json, содержащий информацию о плагине.

Примечание:

Папки licenses и icon не являются обязательными. Файлы лицензий и файлы с используемыми пиктограммами могут находиться в корне.

Для внешних систем-приемников данных из Traffic Monitor файл manifest.json должен содержать следующую информацию:

Содержимое

Тип данных

Является
обязательным

Описание

{   

"PLUGIN_ID": "",

Строка

Да

Уникальный идентификатор (UUID) плагина, который создается его разработчиком. До 40 символов.
Идентификатор используется для обновления плагина.
Пример: "PLUGIN_ID": "189C38D390396EB6E0530100007F1CA200000001",

"DISPLAY_NAME": "",

Строка

ДаОтображаемое имя плагина.
Пример: "DISPLAY_NAME": "Имя плагина",
"DESCRIPTION": "",СтрокаНетОтображаемое описание плагина.
Пример: "DESCRIPTION": "Тестовый плагин для демонстрации",
  "VERSION": "",СтрокаДаВерсия плагина.
Пример: "VERSION": "1.0.0",
"VENDOR": "",СтрокаДаИдентификатор компании-разработчика, соответствующий названию компании в лицензии.
Пример: "VENDOR": "infowatch",

"LICENSE": [
{
"PATH":""
}
],

Массив

Строка		Да

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

Пример 
"LICENSE": [
    {
		"PATH": "licenses/файл лицензии 1.license"
	},
	{
		"PATH": "licenses/файл лицензии 2.license"
	},
],
"PATTERN_SEARCH_LICENSE": "",СтрокаНетШаблон для поиска загруженных ранее лицензий для привязки их к плагину. Имеет формат: {operator:or|and,child[{name:value}]}".
Пример: "PATTERN_SEARCH_LICENSE": "{\"operator\":\"or\",\"conditions\":[{\"origin\":\"dm\"},{\"origin\":\"dmmobile\"}]}",

"DATA_RECEIVER": [

""
]

Массив

Строка

Да

Список идентификаторов систем-приемников данных из Traffic Monitor.

Пример 
"DATA_RECEIVER": [
	"Events reciever1",
	"Events reciever2"
     ]
"OBJECT_HEADER": [
{
"NAME": "",


"NOTE": {
"": "",
"": ""
},
"TYPE": "",
"FORMAT": "",

"DATA_CLASS": [""],
"USE_IN_POLICY": "",
"USE_IN_NOTIFICATION": "",
"USE_IN_QUERY": "",
"USE_IN_LIST": "",
"USE_IN_SHOW": "",
"USE_IN_DETAIL": "",
"IS_MULTIPLE_VALUE": "",
}
]

Массив

Строка


Объект
Строка


Перечисление
Перечисление

Массив строк
Перечисление
Перечисление

Перечисление
Перечисление
Перечисление
Перечисление

Перечисление

Нет

Пользовательские атрибуты событий.

Уникальный код атрибута, который будет использован в заголовках события и для идентификации в xAPI/PushAPI.
Если идентификатор разработчика не "IW", код должен начинаться с префикса "<Идентификатор компании-разработчика>_".
Пример: CISCO_CALL_DURATION
Название атрибута, отображаемое в консоли Traffic Monitor.



Тип значения.
Формат записи. Возможны значения: число (целое, дробное), строка, дата и время в UTC + указание смещение часового пояса, длительность, гиперссылка, перечисление, логический тип.
Сервисы, к событиям которых будет добавлен новый пользовательский атрибут.
Использование атрибута в политиках. "1" - да, "0" - нет.
Использование атрибута в почтовых уведомлениях. "1" - да, "0" - нет.

Использование атрибута в запросах. "1" - да, "0" - нет.
Отображение атрибута в табличном режиме просмотра событий. "1" - да, "0" - нет.
Отображение атрибута в краткой форме просмотра события. "1" - да, "0" - нет.
Отображение атрибута в детальной форме просмотра события. "1" - да, "0" - нет.

Множественное значение. "1" - да, "0" - нет.

Пример 
"OBJECT_HEADER": [
    {
		"NAME": "header_multi_string",
		"NOTE": {
			"rus": "Заголовок строк1",
			"eng": "Header strings1"
		},
		"DATA_CLASS": ["kEmail"],
		"USE_IN_POLICY": "1",
		"USE_IN_QUERY": "1",
		"USE_IN_NOTIFICATION": "1",
		"USE_IN_LIST": "1",
		"USE_IN_SHOW": "1",
		"USE_IN_DETAIL": "1",
		"TYPE": "string",
		"FORMAT": "string",
		"IS_MULTIPLE_VALUE": "1"
	},
	{
		"NAME": "header_date",
		"NOTE": {
			"rus": "Заголовок дата1",
			"eng": "Header date1"
		},
		"DATA_CLASS": ["kEmail"],
		"USE_IN_POLICY": "1",
		"USE_IN_QUERY": "1",
		"USE_IN_NOTIFICATION": "1",
		"USE_IN_LIST": "0",
		"USE_IN_SHOW": "1",
		"USE_IN_DETAIL": "1",
		"TYPE": "string",
		"FORMAT": "date",
		"IS_MULTIPLE_VALUE": "0"
	}
]
}   


  • Нет меток