Операционные панели можно улучшать путём эффективного использования параметров URL. Параметр URL – это свойство, которое добавляется в конфигурацию операционной панели её автором, чтобы использовать для действий запуска. При этом параметры URL позволяют отображать операционную панель заданным образом. Параметры URL также удобно использовать, когда операционная панель встроена в другое приложение. В этом случае хост-приложение можно использовать для изменения текущего вида операционной панели.
Примечание:
За исключением встроенного параметра языка, изменение параметров операционной панели во время выполнения не приведет к ее перезагрузке в большинстве современных браузеров.
Параметр URL - это пара имя-значение. В каждом параметре имя и значение разделены знаком равенства (=). Во время выполнения можно добавить параметр в конец URL операционной панели с помощью знака вопроса (?), за которым следует параметр.
Например, URL панели мониторинга, содержащий параметр, может выглядеть как <scheme>://<yourPortalUrl>/apps/opsdashboard/index.html#/<id>?param=value.
Для нескольких параметров между каждым добавляется амперсанд (&): <scheme>://<yourPortalUrl>/apps/opsdashboard/index.html#/<id>?param=value¶m2=value2
Подсказка:
Порядок параметров не имеет значения. Например , param=value¶m2=value2 и param2=value2¶m=value выдадут одинаковый результат.Имена параметров состоят из буквенно-цифровых символов ASCII. Тире (-) и подчеркивание (_) также разрешены в любом месте, кроме начала. Недопустимые символы блокируются во время разработки с сообщением проверки. Рекомендуется избегать использования длинных имен параметров.
Примечание:
Некоторые имена параметров были зарезервированы для внутреннего использования, например, mode и edit. При создании параметра, если вы используете зарезервированное имя, появится предупреждение проверки Уже используется.
Внимание:
Параметры URL и селекторы используются для обеспечения взаимодействия между элементами операционной панели. Однако при использовании одинаковых элементов в качестве целевых они могут противоречить друг другу и вызывать неожиданные результаты. Будьте внимательны при проектировании взаимодействий в панели.Кодировка URL
При передаче параметра на операционную панель во время выполнения закодируйте его значение. Кодировка гарантирует, что недопустимые символы будут заменены на % со следующим после шестнадцатеричным эквивалентом.
Например, передача значения Main Street через параметр URL будет выглядеть следующим образом:<scheme>://<yourPortalUrl>/apps/opsdashboard/index.html#/<id>?param=Main%20Street
При передаче параметра URL в виде списка значений, разделенных запятыми, имейте в виду следующее:
- Кодируйте каждое значение отдельно.
Правильно
?param=Main%20Street,Broadway%20AvenueНеверно. Не кодируйте запятую, используемую для разделения значений.
?param=Main%20Street%2CBroadway%20Avenue - Не включайте пробелы между значениями.
Правильно
?param=Main%20Street,Broadway%20AvenueНеправильно
?param=Main%20Street, Broadway%20Avenue
Типы параметров URL
Существует пять типов параметров URL: Category, Numeric, Date, Feature и Geometry. Более подробно о типах действий, которые могут запускаться различными типами параметров, см. Конфигурирование действий параметров URL.
Параметр категории
Параметр категории можно использовать для применения действия фильтра к одному или нескольким элементам. Во время разработки необходимо указать для параметра имя, будут ли входные данные числовыми или текстовыми, и будут ли запросы фильтров включать или исключать переданные значения.
Во время выполнения параметры категории принимают одно или несколько значений через запятую. Не ставьте пробел после запятой.
Когда передается одно значение, выполняемый фоном запрос использует оператор сравнения равно или не равно для фильтрации целевых элементов. Когда передается несколько значений, используются логические операторы IN или NOT IN.
Примеры
В следующей таблице приведены примечания, указывающие, был ли параметр категории настроен на ожидание строки или числа:
| Параметр | Знак |
|---|---|
| ?status=DAMAGED | Строковое |
| ?status=DAMAGED,DESTROYED | Строка с несколькими значениями |
| ?category=1 | Числовое |
| ?category=1,2 | Число с несколькими значениями |
Примеры особых случаев
Категории данных устанавливаются не всегда, или в случае со строками могут быть пустыми. Соответственно, параметры категорий поддерживают четыре особых случая:
- ((null))
- ((notnull))
- ((empty))
- ((notempty))
| Параметр | Знак |
|---|---|
| ?status=((null)) | Фильтр со значениями NULL. |
| ?status=((notnull) | Фильтр со значениями NOT NULL. |
| ?status=((empty)) | Фильтр с пустыми значениями. |
| ?status=((notempty)) | Фильтр не с пустыми значениями. |
| ?status=DAMAGED,((null)) | Фильтр передаваемыми значениями ИЛИ являющимися NULL. |
| ?status=DAMAGED,DESTROYED,((null)) | Фильтр несколькими передаваемыми значениями ИЛИ являющимися NULL. |
Числовые параметры
Можно использовать числовые параметры для применения действия фильтра к одному или нескольким элементам. Во время разработки необходимо указать имя параметра и то, будут ли ожидаемые входные значения одним значением или двумя значениями, представляющими диапазон. Если используется одно значение, параметр настроен для применения одного из следующих операторов сравнения:
- равно
- не равно
- меньше
- меньше или равно
- больше
- больше или равно
Подсказка:
Чтобы тщательнее контролировать, чем используя тип значения диапазона, создайте два отдельных числовых параметра и примените условие фильтра (оператор), отвечающее вашим требованиям. Во время выполнения отдельные параметры будут объединены с логическим оператором И при применении фильтра к целевым элементам.
Во время выполнения числовые параметры передаются как одно значение или два значения, разделенные запятой.
Примеры
В следующей таблице приведены примечания, указывающие, был ли числовой параметр настроен на ожидание Одного значения или Диапазона:
| Параметр | Знак |
|---|---|
| ?meas=10 | Одно значение |
| ?meas=10,15 | Радиус действия |
Примеры особых случаев
Числовые значения в данных устанавливаются не всегда. Соответственно, числовые параметры поддерживают два особых случая: ((null)) и ((notnull)). Эти подписи особых случаев можно использовать как для рабочих процессов с одним значением, так и для диапазонов числе.
| Параметр | Знак |
|---|---|
| ?meas=((null)) | Одно значение данных или числовой диапазон. Фильтр со значениями NULL. |
| ?meas=((notnull)) | Одно значение данных или числовой диапазон. Фильтр со значениями NOT NULL. |
| ?meas=10,((null)) | Одно значение. Фильтр со значением ИЛИ для значений, которые NULL. |
| ?meas=10,15,((null)) | Числовой диапазон. Фильтр для чисел в диапазоне ИЛИ для значений, которые NULL. |
Другой особый случай – когда числовой параметр ожидает диапазон, но во время выполнения предоставляется только одно значение.
| Параметр | Знак |
|---|---|
| ?meas=,10 | Открытый левый. Значения, которые меньше или равны этому значению, будут отфильтрованы. |
| ?meas=10, | Открытый правый. Значения, которые больше или равны этому значению, будут отфильтрованы. |
| ?meas=10 | Открытый правый. Значения, которые больше или равны этому значению, будут отфильтрованы. |
| ?meas=10,((null)) | Открытый правый. Фильтрует значения, которые больше или равны этому значению ИЛИ равны NULL. |
Параметры дат
Можно использовать параметры дат для применения действия фильтра к одному или нескольким элементам. Во время разработки необходимо указать имя параметра и то, будут ли ожидаемые входные значения строками даты ISO 8601 или UNIX Epoch.
Параметры даты можно настроить для обработки одного значения или двух значений, представляющих диапазон дат. Если используется одно значение, параметр настроен для применения одного из следующих операторов сравнения:
- равно
- не является
- до
- есть или было
- после
- есть или будет
Подсказка:
Чтобы тщательнее контролировать, чем используя тип значения диапазона, создайте два отдельных параметра дат и примените условие фильтра (оператор), отвечающее вашим требованиям. Во время выполнения отдельные параметры дат будут объединены с логическим оператором И при применении фильтра к целевым элементам.Во время выполнения параметры дат передаются как одно значение или два значения, разделенные запятой. Если параметром даты является UNIX Epoch, он должен быть 32-разрядным целым числом со знаком. Если это строка, даты должны быть отформатированы как ГГГГ-ММ-ДД или ГГГГММДД. Даты вводятся с использованием григорианского календаря и состоят из лет, месяцев и дней.
- ГГГГ – четырехзначный год (YYYY)
- ММ – двузначный месяц года (от 01 до 12)
- ДД – двузначный день (от 01 до 31)
Подсказка:
Список форматов дат, поддерживаемых параметрами даты, отличается от тех, которые поддерживаются серийной диаграммой для разбора дат.
Часть со временем также может быть включена в дату. Время вводится в 24-часовом формате и состоит из часов, минут и секунд. Их можно отформатировать как hh:mm:ss или hhmmss. Если часть времени не включена в дату, подразумевается весь день от 00:00:00 до 23:59:59.
- hh – час с добавлением нуля от 00 до 24
- mm – минута с добавлением нуля от 00 до 59
- ss – секунда с добавлением нуля от 00 до 59
Если указано, часть времени отделяется от части даты пробелом или заглавной буквой Т. Ниже приведены допустимые даты, передаваемые в виде строк:
| Дата | Знак |
|---|---|
2018-10-31 | Только дата |
20181031 | Только дата (альтернативный формат) |
2018-10-31T23:14:42 | Дата и время, разделённые T |
20181031T231442 | Дата и время, разделённые T (альтернативный формат) |
2018-10-31 23:14:42 | Дата и время, разделённые пробелом |
20181031 231442 | Дата и время, разделённые пробелом (альтернативный формат) |
Подсказка:
Рекомендуется разделять дату и время заглавной буквой T. Если используете пробел, кодируйте его.
Когда даты передаются на операционную панель во время выполнения, предполагается, что их временная составляющая задается в местном часовом поясе — то есть часовом поясе машины или устройства, на котором работает браузер. Для улучшения контроля время также можно указать как всемирное координированное время (UTC) или как смещение от UTC. Чтобы указать, что время указано в UTC, добавьте букву Z сразу после времени без пробела. Z – это указатель зоны для нулевого смещения UTC. Смещение от UTC добавляется к времени в виде ±hh:mm, ±hhmm или ±hh.
| Дата | Знак |
|---|---|
2018-10-31T23:14:42Z | UTC |
2018-10-31T23:14:42+01:00 | На один час вперёд относительно UTC |
2018-10-31T23:14:42+0100 | На один час вперёд относительно UTC |
2018-10-31T23:14:42+01 | На один час вперёд относительно UTC |
2018-10-31T23:14:42-05:00 | На пять часов назад относительно UTC |
2018-10-31T23:14:42-0500 | На пять часов назад относительно UTC |
2018-10-31T23:14:42-05 | На пять часов назад относительно UTC |
При построении фильтров из параметров даты операционные панели проверяют источник данных целевого элемента на наличие информации о часовом поясе. При обнаружении запрос будет отправлен в этом часовом поясе. Если информация о часовом поясе не найдена, предполагается, что целевым источником данных является UTC. В любом случае, операционной панели, возможно, потребуется привести время ввода в соответствие с целевым.
Подсказка:
Если операционная панель получает параметр даты в формате, который она не распознает, он будет игнорироваться во время выполнения.Примеры
В следующей таблице приведены примечания, указывающие, был ли параметр дат настроен на ожидание одной даты или диапазон дат. UNIX Epoch и примеры строк даты предоставляются.
| Параметр | Знак |
|---|---|
| ?created=1541027682 | Одно значение с использованием UNIX Epoch. |
| ?created=2018-10-31 | Одно значение с использованием строки даты, с предполагаемым полным днем. |
| ?created=2018-10-31T23:14:42 | Одно значение с использованием строки даты с указанием времени. Подразумевается местное время. |
| ?created=2018-10-31T23:14:42Z | Одно значение с использованием строки даты с указанием времени в UTC. |
Примеры особых случаев
Значения даты устанавливаются не всегда. Соответственно, параметры даты поддерживают два особых случая: ((null)) и ((notnull)). Эти подписи особых случаев можно использовать как для рабочих процессов с одним значением, так и для диапазонов дат.
| Параметр | Знак |
|---|---|
| ?created=((null)) | Одно значение или диапазон дат. Фильтрует NULL в датах. |
| ?created=((notnull)) | Одно значение или диапазон дат. Фильтрует даты, которые NOT NULL. |
| ?created=2018-10-31,((null)) | Одно значение дат. Фильтрует October 31 ИЛИ даты, в которых NULL. |
| ?created=2018-10-31,2018-11-05,((null)) | Диапазон дат. Фильтрует диапазон дат ИЛИ даты, в которых NULL. |
Другой особый случай – когда параметр дат ожидает диапазон, но во время выполнения предоставляется только одно значение.
| Параметр | Знак |
|---|---|
| ?created=,2018-10-31 | Открытый левый. Даты, соответствующие или до фильтра. |
| ?created=2018-10-31, | Открытый правый. Даты, соответствующие или после фильтра. |
| ?created=2018-10-31,((null)) | Открытый правый. Фильтрует даты начиная с ИЛИ даты, в которых NULL. |
Параметры объектов
Параметры объектов используются для передачи одного или нескольких ID объектов на операционную панель. Их можно использовать для фильтрации элементов операционной панели или для применения действий с местоположением – Масштабировать, Переместить, Показать всплывающее окно, Следовать вдоль объекта и Подсветить – к картам операционных панелей.
Во время разработки необходимо указать имя параметра и выбрать источник данных. Поле уникального идентификатора источника данных должно быть идентифицировано. Невозможность выбрать поле, содержащее неуникальные значения, приведет к неожиданному поведению во время выполнения.
Подсказка:
Если выбранный источник данных содержит полигоны, его можно использовать для применения пространственных фильтров к целевым элементам.Во время выполнения убедитесь, что URL кодирует идентификаторы объектов, если значения в целевом слое являются строками. Можно указать несколько идентификаторов объектов, разделив их запятыми, например, ?asset=1240,1241,1242. Не ставьте пробел после каждой запятой.
Подсказка:
Если параметр объекта сконфигурирован для выполнения действия Следовать вдоль объекта, ожидается только один идентификатор. Если передано несколько значений, будет следовать только вдоль одного объекта. Не обязательно вдоль того объекта, ID которого идёт по порядку передачи.Примеры
| Параметр | Знак |
|---|---|
| ?id=11033 | Одно значение |
| ?id=11033,23034,34035 | Несколько значений |
Параметры геометрии
Существует два типа геометрических параметров: точка и экстент. Если тип точечный, геометрические параметры используются для увеличения, перемещения или подсветки местоположения на одной или нескольких картах операционной панели. Если типом является экстент, параметры геометрии могут использоваться для установки экстентов карты операционной панели или для фильтрации других ее элементов. Во время разработки необходимо указать имя параметра и выбрать тип геометрии перед настройкой любых действий.
Во время выполнения все геометрические координаты передаются в виде значений Всемирной геодезической системы 1984 (WGS84), через запятые. Для точечных параметров форматом является x,y. Для параметров экстента этот формат leftX,leftY,rightX,rightY. Во всех случаях после запятой нет пробела.
Примеры
| Параметр | Знак |
|---|---|
| ?pt=-75.6971931,45.4215296 | Параметр геометрии ожидает точку |
| ?ext=-80.6,40.6,-70.7,47.7 | Параметр геометрии ожидает экстент |
Переключение языка
Операционные панели имеют встроенный URL-параметр, обозначающий региональные настройки, для переключения языка, формата чисел и формата дат при отображении содержания. Добавьте параметр ?locale=<language code> в конец URL операционной панели. Этот встроенный параметр можно использовать вместе с любым параметром URL, настроенным автором, разделив несколько параметров URL амперсандом (&).
В следующей таблице перечислены поддерживаемые языковые коды:
| Код языка | Язык |
|---|---|
ar | Арабский |
bs | Боснийский |
ca | Каталонский |
cs | Чешский |
da | Датский |
de | Немецкий |
el | Греческий |
ru | Английский |
es | Испанский |
et | Эстонский |
fi | Финский |
fr | Французский |
he | Иврит |
hr | Хорватский |
hu | Венгерский |
Идентификатор | Индонезийский |
it | Итальянский |
ja | Японский |
ko | Корейский |
lt | Литовский |
lv | Латышский |
nb | Норвежский букмол |
nl | Нидерландский |
pl | Польский |
pt-br | Португальский (бразильский) |
pt-pt | Португальский (Португалия) |
ro | Румынский |
ru | Русский |
sl | Словенский |
sr | Сербский |
sv | Шведский |
th | Тайский |
tr | Турецкий |
uk | Украинский |
vi | Вьетнамский |
zh-cn | Китайский (упрощенный) |
zh-hk | Китайский (традиционный – Гонконг) |
zh-tw | Китайский (традиционный – Тайвань) |
При использовании английского, испанского, французского, немецкого и итальянского языковых кодов вы также можете использовать следующие региональные стандарты для установки формата номера и даты:
| Региональный стандарт | Числовой формат и формат дат |
|---|---|
en-au | Английский (Австралия) |
en-ca | Английский (Канада) |
en-gb | Английский (Великобритания) |
es-es | Испанский (Испания) |
es-mx | Испанский (Мексика) |
fr-ch | Французский (Швейцария) |
de-ch | Немецкий (Швейцария) |
it-ch | Итальянский (Швейцария) |
Следующий URL – это пример указания французского регионального стандарта:
https://<yourPortalUrl>/apps/opsdashboard/index.html#/4f539791b2f1418cb5403891f1a7be50?locale=fr