Содержание


Обзор персонализации IBM Connections 3.0.1

Адаптация IBM Connections

Comments

IBM Connections предоставляет платформу социального ПО, основанную на таких средствах совместной работы, как Profiles, Blog и Wikis, каждое из которых можно адаптировать под свои бизнес-требования. Обычно при такой адаптации меняют цвета в соответствии с корпоративным брендом и добавляют информацию на страницы профилей. В предыдущих версиях IBM Connections такая настройка требовала значительных усилий от разработчиков. В версии IBM Connection 3.0.1 процесс персонализации существенно упростился; вносить изменения стало проще и безопаснее.

В данной статье предоставлен общий обзор базового процесса и рассмотрены типичные примеры персонализации. Кроме того, предлагаются полезные инструменты и передовые методики. Ссылки на подробные пошаговые инструкции по персонализации приведены в разделе Ресурсы.

Обзор

IBM Connections 3.0.1 поддерживает изменение многих аспектов своего внешнего вида без изменения исходного кода установленных Web-приложений. Пользовательский интерфейс персонализируется путем изменения установленных файлов в специальном каталоге персонализации. Обновленные файлы в каталоге персонализации автоматически изменяют соответствующие файлы в каталогах с исходными кодами. Процесс персонализации использует возможности расширенного корневого каталога документов IBM WebSphere®, предоставляя приложениям IBM Connections возможность обращаться к файлам, расположенным вне каталога Web-архива приложения. Отделение персонализированных файлов от установленных помогает идентифицировать изменения и легко вернуться к исходному состоянию. Кроме того, благодаря этому обновления и пакеты исправления ошибок, примененные к файлам по умолчанию, не затрагивают индивидуальные настройки.

Планирование

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

Необходимые навыки

Персонализация IBM Connections состоит просто в сохранении файлов в каталоге персонализации и их редактировании. Но чтобы определить, какой файл следует менять, и понять, что именно менять, желательно иметь соответствующие навыки. Эти навыки можно разделить на три роли:

  • Администраторы:
    • Настраивают IBM Connections в соответствии с целями своей организации.
    • Поддерживают установку продуктов и публикуют изменения.
    • Взаимодействуют с разработчиками для обновления персонализированных файлов при развертывании пакетов исправления ошибок.
  • Дизайнеры:
    • Определяют, как персонализировать IBM Connections в организации.
    • Создают файлы изображений и указания по персонализации.
  • Web-разработчики:
    • Реализуют персонализацию HTML-страниц при помощи JavaServer Pages™ (JSP), каскадные таблицы стилей (CSS) и JavaScript.
    • Обновляют персонализированные файлы после применения пакетов исправления ошибок или iFixes.
    • Реализуют более глубокую персонализацию или интеграцию Profiles, Communities или других приложений, требующих кодирования на Java™.

Перед началом работы

Процесс персонализации требует изменения файлов, которые могут находиться в кэш-памяти сервера или клиента. Поэтому во избежание недоразумений выполните несколько предварительных действий, чтобы двигаться в нужном направлении.

В процессе персонализации IBM Connections важную роль играют две переменные WebSphere. Эти переменные можно просмотреть и обновить из консоли IBM WebSphere Application Server Integrated Solutions Console.

Разрешение отладки персонализации

Если возможность отладки персонализации запрещена, новые версии персонализированных файлов загружаются только после перезапуска приложений IBM Connections. Разрешив возможность отладки, можно тестировать свои изменения сразу после обновления страницы в браузере. Поскольку возможность отладки является ресурсоемкой, разрешайте ее для IBM Connections только на время выполнения персонализации. Также не разрешайте отладку на рабочем сервере. Возможность отладки задается переменной CONNECTIONS_CUSTOMIZATION_DEBUG.

Путь к каталогу персонализации

Путь к каталогу, объявленный в переменной окружения WebSphere CONNECTIONS_CUSTOMIZATION_PATH, указывает базовое местоположение каталога персонализации, используемого IBM Connections. Эта переменная указывается во время установки IBM Connections. IBM Connections использует файлы этого каталога для изменения установленных файлов. При использовании во время установки значений по умолчанию путь к каталогу персонализации будет следующим: каталог_установки_Connections\data\shared\customization.

Путь к каталогу персонализации можно проверить из консоли WebSphere Application Server Integrated System Console. Все персонализированные файлы необходимо поместить в соответствующие подкаталоги данного каталога.

Процесс персонализации

При выполнении большинства задач персонализации пользовательского интерфейса файл, содержащий информацию по умолчанию, копируют из каталога с исходными файлами в соответствующий подкаталог каталога персонализации. Затем скопированный файл редактируют и сохраняют. При визуализации страницы IBM Connections использует информацию из файла, расположенного в каталоге персонализации.

Откат персонализации представляет собой обратный процесс. Если вы хотите отказаться от персонализации, просто удалите измененный файл и перезапустите соответствующие приложения. Файлы в подкаталоге common влияют на все приложения IBM Connections. Файлы в подкаталогах приложений влияют только на эти приложения и меняют файлы каталога common.

Например, для изменения нижнего колонтитула во всех приложениях, кроме Activities, измените нижний колонтитул в каталоге common и выполните дополнительные изменения в каталоге персонализации Activities. Для изменения нижнего колонтитула только в приложении Activities выполните изменения только в каталоге персонализации Activities. На рисунке 1 продемонстрирована очередность обработки для заголовка и нижнего колонтитула во всех приложениях или только в приложении Profiles.

Рисунок 1. Очередность персонализации
Очередность персонализации
Очередность персонализации

Рисунок показывает, что файлы каталога персонализации Profiles изменяют файлы каталога common. Файлы, находящиеся в любом каталоге персонализации, изменяют установленные файлы.

Типичные примеры персонализации

В IBM Connections 3.0.1 самые востребованные задачи персонализации выполняются с минимальными усилиями. Можно изменить цвета на соответствующие корпоративным стандартам или создать страницу входа в систему, удовлетворяющую вашим требованиям. В данном разделе рассказывается, как выполнить наиболее типичные варианты персонализации.

Обычно первым действием по персонализации является изменение заголовка и нижнего колонтитула путем добавления логотипа компании, применения корпоративных цветов или добавления ссылок в меню (см. рисунок 2). Для обновления заголовка для всех приложений нужно просто скопировать файл header.jsp по умолчанию, версия которого размещена в исходном каталоге каждого приложения, в каталог персонализации. Для персонализации схемы или функциональности в этот файл можно добавить стандартный JSP- или HTML-код. Это могут быть гиперссылки или новые раскрывающиеся меню, ссылающиеся на другие приложения. Затем просто сохраните измененный файл в соответствующем подкаталоге каталога персонализации.

Рисунок 2. Пример персонализации заголовка
Пример персонализации заголовка
Пример персонализации заголовка

Темы

Кроме придания всему сайту IBM Connections внешнего вида, соответствующего бренду компании, можно создавать наборы файлов, называемые темами (theme), для использования в приложениях Blog и Community. Владелец блога или сообщества может выбрать тему из набора доступных тем для изменения дизайна своей части сайта. Во время установки предоставляется несколько тем по умолчанию, но вы можете создавать дополнительные темы и делать их доступными другим владельцам сайта.

Самым простым способом создания новой темы является копирование существующей темы и изменение JSP- и CSS-файлов для реализации нового внешнего вида и поведения. На рисунке 3 показан пример.

Рисунок 3. Выбор темы приложения Community
Выбор темы приложения Community
Выбор темы приложения Community

Персонализация строк интерфейса продукта

Базовая установка IBM Connections поддерживает много языков и выбирает подходящий язык автоматически на основе языка, используемого посетителем сайта. Такая поддержка языков стала возможной благодаря использованию пакетов ресурсов (resource bundle) – набора файлов, содержащих перевод текста, отображаемого на странице. Для каждого языка имеется свой собственный файл. Вы можете изменить отображаемый текст практически на любой странице, внеся изменения в эти файлы.

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

Однако, в отличие от персонализации других элементов пользовательского интерфейса, для строк, хранящихся в файлах свойств, файлы всегда сохраняются в каталог customization_path/strings. В каталоге strings отсутствуют подкаталоги. Для работы достаточно одного каталога, поскольку имя персонализированного файла свойств включает в себя полный путь к файлу свойств по умолчанию, который он изменяет. В имени персонализированного файла символы косой черты (разделители каталогов) заменяются точками. Например, если вы хотите изменить строку продукта, найденную в файле templates.properties, который хранится в архиве lc.util.web-3.0.jar в каталоге /com/ibm/lconn/core/strings, сохраните персонализированный файл свойств, используя имя com.ibm.lconn.core.strings.templates.properties. Разделители-точки в имени персонализированного файла представляют разделители каталогов в файле по умолчанию.

Кроме того, IBM Connections использует локаль (locale) Web-браузера для автоматического определения языка, отображаемого в пользовательском интерфейсе. Строки сохраняются в файлах, специфичных для языка, и в файлах, независимых от языка. Строки для локали по умолчанию (независимые от языка файлы) хранятся в файле без кода языка в имени файла. Имена специфичных для языка файлов используют в качестве суффикса код языка. Например, файл com.ibm.lconn.core.strings.templates.properties является независимым от языка файлом, содержащим строки, используемые для локали по умолчанию. Если конкретной локали Web-браузера отсутствует, отображаются строки из этого файла свойств по умолчанию. Например, для включения в файл свойств строк с переводом на бразильский португальский язык (Brazilian Portuguese), создайте отдельный файл с именем com.ibm.lconn.core.strings.templates_pt-BR.properties. Строки из этого файла будут применяться для пользователей, использующих локаль Brazilian Portuguese.

Более сложная персонализация

Как уже говорилось, большинство задач по персонализации выполняется путем копирования файлов в каталог персонализации. Однако IBM Connections можно персонализировать и другими способами. Виджеты и атрибуты расширения Profile – два примера, использующие другие методы, но предоставляющие дополнительные варианты персонализации платформы IBM Connections.

Атрибуты расширения Profile

Кроме персонализации, изменяющей существующие цвета или текстовые строки, в приложение Profiles можно добавить новые поля данных. IBM Connections предоставляет базовый набор атрибутов для профиля, таких как имя, контактная и персональная информация. Во многих случаях могут понадобиться дополнительные данные. В таких ситуациях используются новые поля данных, называемые атрибутами расширения (extension attributes). Эти новые поля данных могут заполняться автоматически из базы данных, расположенной вне IBM Connections, путем использования программы IBM Tivoli® Directory Integrator, или задаваться владельцем профиля.

Атрибуты расширения Profile используют другой метод реализации, рассмотрение которого выходит за рамки данной статьи. Дополнительная информация приведена в Redbook Wiki-документе "Настройка IBM Connections 3.0.1" (см. раздел Ресурсы).

Виджеты

IBM Connections поддерживает спецификацию iWidget для создания небольших приложений, которые можно помещать на страницы Home Page, Profiles или Community. Виджеты – это небольшие JavaScript-приложения, которые извлекают данные из внешних баз данных или Web-сервисов. Можно разрабатывать виджеты только при помощи JavaScript и CSS, а можно воспользоваться средствами cерверных языков, таких как Java или PHP. В листинге 1 приведен код простого виджета.

Листинг 1. Простой виджет
<iw:iwidget name="helloWorld" xmlns:iw="http://www.ibm.com/xmlns/prod/iWidget">
<iw:content mode="view">
<div>
<div id="helloWorld">Hello World!</div>
</div>
</iw:content>
</iw:iwidget>

В дополнение к возможности написания специализированных приложений-виджетов в каталоге IBM Business Solutions Catalog имеется много доступных для загрузки готовых виджетов.

Полезные инструменты

Определение того, какие файлы какими элементами страниц управляют, может оказаться непростой задачей. Например, бывает трудно определить, какое CSS-правило управляет конкретным элементом пользовательского интерфейса. Кроме того, изменения в конфигурационных XML-файлах должны быть согласованы со схемой, а JSP- и HTML-файлы должны быть корректно структурированы. При персонализации строк пользовательского интерфейса нужно найти в Java-архивах (JAR) места, где хранятся эти строки. При тестировании изменений в переведенных на другой язык строках пользовательского интерфейса необходимо изменить локаль вашего Web-браузера. Для этих задач могут быть полезны следующие вспомогательные программы.

Отключение кэш-памяти браузера

При тестирования выполненных в IBM Connections изменений необходимо часто очищать кэш браузера. Для этого можно использовать средство временного отключения кэширования в браузере, например дополнение Web Developer для браузеров Mozilla Firefox и Google Chrome (ссылка приведена в разделе Ресурсы).

Изменение CSS-правил и элементов пользовательского интерфейса

Используйте средства Web-инспектирования для поиска CSS-правил, которые хотите изменить. Примерами таких средств являются Firebug для Firefox и Chrome, а также Web Inspector для Chrome и Apple Safari. Ссылки приведены в разделе Ресурсы.

Редактирование XML-, JSP- и HTML-файлов

Используйте текстовый редактор, который проверяет корректность тегов, – например, gedit для Linux® и Notepad++ для Windows® (ссылки приведены в разделе Ресурсы). Также можно использовать среду Eclipse, работающую на различных платформах.

Тестирование переведенных строк

Используйте средство переключения локали, меняющее локаль браузера без установки операционной системы для этой локали или изменения настроек операционной системы. Примером такого средства является дополнение Quick Locale Switcher для Firefox и Chrome (ссылка приведена в разделе Ресурсы).

Советы и рекомендации

Приведенные ниже советы упрощают процесс персонализации и облегчают обслуживание в будущем.

Часто делайте резервные копии

Перед внесением изменений делайте резервные копии вашего каталога персонализации в среде разработки. При использовании средства управления исходными кодами добавьте в него каталог персонализации. Если такое средство не применяется, подумайте о его внедрении или создайте свой собственный процесс управления версиями.

Минимизируйте копирование

Копируйте только те файлы, которые нужно изменить в каталоге персонализации. Чем меньше файлов в каталоге персонализации, тем меньше файлов нужно контролировать и тем легче отслеживать изменения.

Документируйте изменения

Отслеживайте изменения, документируя их и добавляя комментарии в файлы. Комментарии помогут вспомнить, где и почему было сделано изменение. При объединении нескольких изменений добавляйте комментарии непосредственно в JSP- и CSS-файлы для упрощения процесса.

Тщательно проверяйте конфигурационные файлы

Иногда бывает необходимо обновить конфигурационные XML-файлы в каталоге конфигурации WebSphere Application Server. Хотя можно отредактировать эти XML-файлы непосредственно, лучше использовать соответствующую команду wsadmin. Использование wsadmin гарантирует, что XML-файлы будут правильно сформированы до фиксации изменений в репозитории. Подробная информация по использованию программы командной строки wsadmin приведена в документации.

Обновляйте значение метки времени

Страницы IBM Connections и их CSS- и JavaScript-компоненты обычно кэшируются браузером для улучшения производительности. После выполнения работ по персонализации обновите кэш, чтобы заставить браузер загрузить свежие копии измененных файлов. Для обновления метки версии соответствующего конфигурационного файла можно использовать программу WebSphere Application Server wsadmin.

Заключение

IBM Connections предоставляет платформу социального ПО, которую можно настроить под бизнес-требования конкретной компании. В версиях до 3.0.1 персонализация требовала значительных усилий от разработчиков. Однако теперь процесс стал значительно проще, легче и безопаснее облегчило.


Ресурсы для скачивания


Похожие темы


Комментарии

Войдите или зарегистрируйтесь для того чтобы оставлять комментарии или подписаться на них.

static.content.url=http://www.ibm.com/developerworks/js/artrating/
SITE_ID=40
Zone=Lotus
ArticleID=943315
ArticleTitle=Обзор персонализации IBM Connections 3.0.1
publish-date=09032013