Упрощайте поиск объектов платформы: как работает индексация ссылок на Case Platform

Зачастую при работе с большим количеством объектов пользователи сталкиваются с такой проблемой: поиск объектов становится неупорядоченным и затруднительным, что снижает производительность и увеличивает времязатраты разработчиков при реализации сложных решений. В таком случае ключевой составляющей для ускорения процесса поиска является индексация. 

Индексация ссылок на Case Platform играет важную роль в создании структурированной карты взаимосвязей между объектами. Система не только позволяет эффективно искать объекты платформы, но и отслеживать взаимосвязи между ними, что значительно упрощает разработку и управление приложениями. 

В этой статье мы детально рассмотрим, как работает индексация ссылок на объекты Case Platform, а также инструменты просмотра ссылок. 

Что такое индексация ссылок? 

В общем случае под индексацией понимают процесс построения поисковой системы, при котором добавляется информация о сайте или странице в базы данных. На Case Platform инструменты индексации позволяют пользователю увидеть, где и в каком виде использован объект или его элементы. 

Для обеспечения индексации ссылок на платформе используются как ее встроенные инструменты, так и внешние поисковые системы, такие как  Elasticsearch или OpenSearch.

На Case Platform можно просматривать ссылки на некоторые объекты и их элементы. К таким объектам относятся типы, перечисления, процессы, формы, абстрактные формы и пользовательские функции. 

Ссылки на объект отображаются на его вкладке «Используется в». Однако ее местоположение и внешний вид могут отличаться в зависимости от объекта.  

Какие инструменты индексации доступны на Case Platform?  

Индексация с помощью встроенных инструментов

Такой инструмент доступен для всех объектов, которые поддерживают индексацию и были перечислены ранее. Как правило, для каждой ссылки доступна следующая информация: 

• объект приложения, где расположена ссылка; 
• модуль, в котором расположен этот объект; 
• полный путь до объекта (атрибута, скрипта, блока формы), где расположена ссылка.

Кроме того, зачастую с этой вкладки можно перейти к объекту, который содержит ссылку. 

Если полнотекстовый индекс приложения (режим поиска, позволяющий искать следующие компоненты приложения по имени: объекты приложения, атрибуты, поисковые методы, компоненты диаграммы форма или процесс) устарел и требует обновления, то при открытии вкладки «Используется в» система предложит вам обновить индекс. Для этого нажмите «Обновить». Обновление индекса можно также осуществить самостоятельно на вкладке приложения «Поиск». 

Индексация с помощью внешней системы поиска

Для осуществления такого вида индексации на платформе используются поисковые системы Elasticsearch или OpenSearch, установка которых осуществляется с при установке системы трассировки.  Внешние  системы позволяют визуализировать данные для анализа и улучшения производительности приложения. На данный момент индексация ссылок с использованием внешней поисковой системы доступна в типах и пользовательских функциях.

Как только поисковая система установлена, следующим этапом необходимо настроить экземпляр платформы. Для этого в директорию на сервере нужно добавить файл библиотеки, а также настроить ряд параметров платформы группы «Полнотекстовый поиск». Когда на стенде будет включено использование поисковой системы Elasticsearch или OpenSearch, внешний вид вкладки для просмотра ссылок в типах и пользовательских функциях изменится. 

Как обновить и просмотреть ссылки на вкладке «Используется в» 

В качестве примера рассмотрим вкладку «Используется в» в типе. При первом открытии вкладки список ссылок может не отображаться. Чтобы их отобразить, на панели инструментов нажмите «Обновить индекс».

Для каждого объекта указывается отдельный список ссылок. В названии списка содержатся категория и наименование используемого объекта, например, «Атрибут типа» и имя атрибута. Для типа отображаются ссылки на сам тип, его атрибуты и поисковые методы, а для функции — на саму функцию и её аргументы. 

Список ссылок обновляется с частотой, заданной в параметрах платформы. Тем не менее его также можно обновить вручную. Для этого нажмите «Обновить индекс» на панели инструментов. 

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

Для каждой ссылки также отображается путь до объекта или содержащего ее элемента. В таком случае выводится полный путь до объекта приложения — имя модуля, пакета и объекта. Если объект используется несколько раз в одной или разных строках скрипта, то для каждого случая использования на вкладке будет отображаться отдельная запись. 

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