1. Назначение
Картотека ВШЭ предназначена для использования на узлах (сайтах) в составе Microsoft SharePoint Portal Server или Microsoft SharePoint Services. Представляет собой набор веб-частей и утилит (объектов). Веб-части используются совместно со стандартными элементами SPS/WSS.
Особенностью картотеки является возможность использовать данные списков и библиотек документов и рисунков с других узлов Шарепойнт.
2. Шаблон ВШЭ
Веб-часть является вспомогательным элементом и используется для генерации списков, служащих шаблонами для построения «ВШЭ-карточек» при помощи веб-части «Список ВШЭ».
2.1. Создание шаблона карточки
Введите в поле ввода имя шаблона списка и нажмите кнопку «Make». В результате будет создана заготовка шаблона карточки Тест ВШЭ. Шаблон является стандартным SharePoint-списком и содержит определения полей для формирования записей шаблона.
2.2. Редактирование шаблона
Выберите пункт меню «Списки» и откройте список «Тест ВШЭ». Выберите пункт меню «Создать элемент» и в открывшейся форме задайте определения полей «ВШЭ-карточки».
Одному полю карточки соответствует элемент (строка) списка–шаблона.
2.2.1. Поля шаблона
|
Имя |
Используется для идентификации поля при выводе и при ссылках на список. |
|
Определяет способ ввода информации в поле. Выбирается из списка типов: 0 - Ввод текста руками в однострочное текстовое поле 10 - То же, в многострочное RTF-поле 13 - То же, в многострочное поле без форматирования 11 - То же, из «Списка ВШЭ» | |
|
Сайт |
Для полей типа 1,2,11 определяет URL источника данных для поля. Могут задаваться относительные или абсолютные адреса сайтов (напр., http://server/sites/config и /config). В случае нахождения источника на другом сервере следует задавать его абсолютный адрес. В этом случае может потребоваться настройка параметров глобального пользователя.Источник должен иметь общий корень дерева сайтов с потребителем – «карточкой ВШЭ», например, http://server/sites/. |
|
Список |
Определяет имя списка, служащего источником данных. |
|
Поле |
Определяет имя поля списка–источника, значения которого будут использованы для формирования набора значений для выбора. |
|
Внутр.имя |
Определяет служебное значение, связываемое с полем. Значение должно быть уникальным для списка–шаблона, возможно использование порядкового номера поля в списке полей карточки. |
|
Комментарий |
Может содержать любую информацию, которая будет полезна при работе с карточкой. |
|
Используется для полей типов 1 и 11. Служит для фильтрации информации в списке в зависимости от значения других полей формы. Фильтр состоит из записей вида | |
|
Используется для полей типов 1 и 11. Служит для заполнения полей формы информацией из списка–источника. Содержит набор правил присваивания вида Имя поля, которому задаётся присваивание, может быть снабжено суффиксом многократного присваивания – поле_формы{++}=… В этом случае повторный выбор значений будет добавлять значение указанного поля к содержимому поля-приёмника. |
Примечание.
Первое поле формы (первая запись в списке–шаблоне) должно быть типа «0».
[1] Этот же тип следует использовать для выбора из библиотеки документов.
2.2.2. Настройка глобального пользователя
Глобальный пользователь используется для доступа к данным с других веб–серверов через механизм веб–сервисов Шарепойнт. Для задания такого пользователя в файле web.config следует определить параметры логина глобального пользователя:
<appSettings>
<add key="GlobalAdminName" value="user_name" />
<add key="GlobalAdminDomain" value="computer_name" />
<add key="GlobalAdminPassword" value="password" />
</appSettings>
При отсутствии таких параметров для доступа к данным будут использованы разрешения текущего пользователя.
3. Список ВШЭ
Веб-часть является основным элементом управления картотекой – набором структур «Карточка ВШЭ». Обеспечивает создание, модификацию, удаление карточек, а также выполнение некоторых вспомогательных операций.
3.1. Создание списка
Из списка веб-частей выберите «Список ВШЭ» и поместите в нужное место страницы.
3.2. Параметры списка
Параметры списка находятся в группе параметров Cards
|
Names of fields to display |
Имена полей для показа карточек в виде списка. Через запятую перечисляются поля карточек с необязательным указанием ширины поля. Например, «Фамилия, Имя(10), Отчество(13)» Кроме полей, явно заданных в шаблоне карточек, можно указать служебные поля: Author, Editor, Created, Modified, содержащие информацию о пользователях и датах создания и модификации карточки. |
|
Length of field |
Ширина поля при выводе в виде списка, если специально не указана в параметре «Names of fields to display» |
|
Template for Card Site URL |
Определяет URL сайта, на котором находится список-шаблон для картотеки. Например, http://server/sites/config или /config. Если поле пустое, список-шаблон ищется на сайте, на котором установлена картотека. |
|
Template for Card |
Имя списка-шаблона. Например, «Тест ВШЭ» |
|
Url of List site |
Определяет адрес сайта, являющегося родительским для подсайта структур картотеки. Поиск данных производится по тем же алгоритмам, что и поиск удалённых списков-источников – см. 2.2.1. Использование этого параметра позволяет редактировать картотеки, расположенные на других сайтах. |
|
Name of List site |
Определяет имя сайта, в котором будет сформирована структура картотеки. По умолчанию поле имеет значение вида Cards_57a986673fe748cda9d9105e6e6b7d19. При необходимости, можно изменить это имя на любое другое. Следует учесть, что замена имени в момент, когда уже имеются сформированные карточки, может привести к потере данных картотеки и к началу формирования нового набора карточек. |
|
Description of List site |
Описание Вашей картотеки. Например, «Карточки сотрудников» |
|
Определяет заголовок сайта, в котором будет сформирована структура картотеки, и заголовок веб-части. Например, «Картотека Сотрудников». | |
|
Caption of Add_Card button |
Надпись на кнопке добавления новой карточки. Например., «Новая карточка» |
|
Empty Banner |
Текст, выводимый в поле веб-части при отсутствии данных в картотеке. Параметр может содержать произвольный html–текст, отвечающий задаче, для которой используется веб-часть. Например, “<b>Пока</b> в списке нет <i>ни одной карточки</i>”. Наряду с текстом, параметр может содержать ссылку на документ в библиотеке SharePoint в формате «!!D:url_сайта::имя_библиотеки::имя_файла», где "!!D:" - признак ссылки, "::" - разделитель полей ссылки. Например, «!!D:/configs::Templates::empty.htm». |
|
Наименование архива картотеки, в который будут переноситься устаревшие карточки. Например, «Архив картотеки сотрудников». Если параметр не задан, наименование формируется из имени списка ВШЭ с добавлением префикса «**arc_» и суффикса в виде числового идентификатора (время создания в тиках таймера компьютера). | |
|
Создавать «Суммарный список» картотеки автоматически. При установке параметра будут отслеживаться изменения и при их наличии выводиться кнопка создания/обновления списка. | |
|
Create Summary List as Contacts |
Создавать «Суммарный список» картотеки в формате списка «Контакты», поддерживающего взаимодействие с MS Outlook 2003. |
|
Allow anonymous |
Позволять анонимным пользователям (и пользователям из групп "Читатель", "Участник") просмотр, редактирование и сохранение информации в карточках. Для этих групп пользователей должны быть доступны также сайты, на которых расположены шаблоны карточек и справочники, использующиеся в карточках. Установку нужного значения этого параметра следует производить после [пере]настройки соответствующих прав доступа к сайтам и страницам. Редактирование и сохранение информации пользователем с ограниченными правами возможно только в версии 2 картотеки (см. ниже). Сброшенное значение параметра (анонимный доступ запрещён) означает доступ пользователей с ограниченными правами (не являющимся администраторами) только к «своим» карточкам (созданным данным пользователем). |
|
Don't show list |
Позволяет заменить выводимую информацию (как правило, отсортированный список карточек) на заставку. |
|
Max cards number |
Максимальное количество карточек в картотеке. |
|
Номер версии картотеки. Номер устанавливается в «1» при организации новой картотеки и заменяется «2» при выполнении функции конвертирования. Возможно ручное изменение номера версии 2 → 1. При этом будет начато формирование новой картотеки. |
3.3. Параметры карточек
Параметры списка находятся в группе параметров Card
|
Description of Card site |
Описание карточки. Например, «Карточка сотрудника». |
|
Title of Card site and webpart |
Заголовок карточки. Например, «Employee Card». |
|
Заполнитель пустых полей карточки. Например, «-». | |
|
Format of date field |
Формат представления полей типа «Дата» («5»). Например, формат «dd.MM.yyyy» соответствует Российским стандартам, формат «yyyy.MM.dd» подходит для сортировки списка по таким полям. Регистр символов форматной строки имеет значение! |
|
Шаблон для показа полей карточки. Поле может содержать либо текст шаблона, либо ссылку на документ в библиотеке SharePoint в формате «!!D:url_сайта::имя_библиотеки::имя_файла», где "!!D:" - признак ссылки, "::" - разделитель полей ссылки. Например, «!!D:/configs::Templates::test.htm». Текст шаблона может содержать ссылки на поля формы и комментарии к ним в формате "__имяПоля__" и "__имяПоля.Description__", вместо которых при выводе подставляются их значения. (Description - значение поля "Комментарий" из шаблона карточки). Всё остальное – по необходимости (коды форматирования, другие html-элементы – ссылки, иллюстрации, пояснения и т.п.). Комбинация "__" (два символа подчёркивания) употребляться для других целей не должна! | |
|
Save and Close |
Установка параметра приводит к закрытию карточки после сохранения данных по нажатию кнопки «Сохранить». При снятом параметре закрытия карточки не происходит. |
3.4. Параметры показа картотеки
Параметры показа находятся в группе параметров Viewers. Предназначены для поиска объектов, использующих данные картотеки.
|
Starting urls in WSS |
Стартовые абсолютные адреса сайтов SharePoint Services, с которых начинается поиск объектов. Адреса отделяются символом «;». Указание первым адресом «*» инициирует поиск по всем доступным узлам. |
|
Starting urls in SPS |
Стартовые абсолютные адреса областей SharePoint Portal Services, с которых начинается поиск объектов. Адреса отделяются символом «;». Указание первым адресом «*» инициирует поиск по всем доступным узлам. |
|
Viewers class Name |
Имя класса веб-части, использующей данные картотеки. |
|
Viewers field Name |
Имя поля веб-части, в которой следует искать упоминания о карточках/картотеке. |
|
Координаты списка, в который помещается заявка на поиск объектов, использующих данные картотеки. Координаты указываются в формате <урл сайта>;<имя списка>. При пустом списке заявка помещается в список hseCardsViewers на головном узле сайта, на котором установлена веб-часть «Список ВШЭ». Из этого же списка выбирается результат поиска объектов. | |
|
Pages with viewers |
Результаты поиска объектов, использующих данные картотеки. |
После установки параметров картотеки следует нажать «ОК» на панели параметров и «Домашняя страница» на панели навигации сайта. Веб-часть приобретёт следующий вид:
3.5. Операции со списком
Выполняются через интерфейс веб-части «Список ВШЭ»
|
Добавление новой карточки |
Выполняется нажатием на соответствующую кнопку, расположенную за таблицей с перечнем имеющихся карточек. Вновь созданная карточка открывается для редактирования. В текстовые поля карточки помещается заполнитель. |
|
Выполняется нажатием на ссылку в первой колонке нужной записи списка имеющихся карточек. Поля карточки заполняются ранее введёнными значениями. | |
|
Сортировка списка |
Выполняется нажатием на наименование поля, по которому необходимо выполнить сортировку. |
|
Используется для создания/обновления списка на текущей странице, содержащего информацию всех карточек картотеки. Имя списка образуется добавлением суффикса «**» к имени веб-части «Список ВШЭ». Выполняется нажатием на соответствующую кнопку, расположенную за таблицей с перечнем имеющихся карточек (формируется в зависимости от установки параметра), или выбором команды «Create Summary List» в меню веб-части. После создания/обновления имя списка и время выполнения операции выводится перед списком карточек. При подключении к редактированию удалённых данных список создаётся на сайте, где установлена веб-часть «Список ВШЭ». | |
|
Перенос карточек в архив |
Выполняется выбором команды «Move to Archive» в меню веб-части. В архивный список, имя которого задано соответствующим параметром, переносятся карточки, имеющие отметку в последней колонке списка карточек. Обратный перенос возможен только в «ручном» режиме (создание новой карточки и заполнение полей информацией). Выполнение операции возможно только в режиме редактирования локальной картотеки. |
|
Выполняется нажатием кнопки «Convert to 2nd version» в панели настройки веб-части. После двукратного подтверждения намерений выполняется преобразование структуры картотеки к новому формату. Данные карточек переносятся в новую структуру, фрагменты старой структуры удаляются. При запуске операции на веб-части, подключённой к удалённой картотеке, производится согласование версии с «родительской» картотекой без выполнения действий над данными. | |
|
Согласование структур хранилища и шаблона |
Выполняется выбором команды «Adjust Storage» в меню веб-части. Производится добавление недостающих в хранилище полей и/или изменение типов полей в соответствии с шаблоном карточки. При невозможности выполнить преобразование типов сообщается об ошибке. После выполнения сообщается затраченное на операцию время. |
|
Выполняется выбором команды «Show Info» в меню веб-части или нажатием кнопки в панели настроек веб–части. Выводится информация об использованном шаблоне карточек, о подключении к удалённой картотеке и о доступности информации для анонимных пользователей. | |
|
Поиск объектов, использующих данные картотеки |
Выполняется выбором команды «Find Viewers» в меню веб-части. При первом вызове формируется заявка на поиск объектов[1], которая помещается в список. При повторном вызове после выполнения поиска объектов результаты поиска записываются в соответствующие карточки. По результатам исполнения выводится сообщение для пользователя. |
[1] В заявку включаются шаблоны для поиска ссылок на отдельные карточки картотеки и на всю картотеку (на «интегральный» список картотеки.
3.6. Операции с карточками
Выполняются из интерфейса формы, доступного после открытия карточки.
|
Редактирование текстовых полей |
Однострочные и многострочные текстовые поля редактируются путём ввода данных с клавиатуры, вставки из буфера обмена и т.д. При соответствующей настройке других полей информация в текстовые поля может добавляться при выборе значений из списков. |
|
Фильтрация списков |
Набор значений в списках выбора может быть ограничен в зависимости от значения в другом поле формы. При наличии такой настройки в шаблоне формы справа от поля со списком выводится кнопка обновления значений. Вначале следует заполнить все поля, от которых зависит набор значений, после чего нажать кнопку обновления. |
|
Сохранение информации |
Выполняется нажатием после заполнения полей информацией кнопки «Сохранить». После сохранения данных произойдёт возврат к списку карточек. |
|
Удаление карточки |
Функция доступна пользователю с достаточными правами. Выполняется после нажатия кнопки «Удалить» и подтверждения выбора пользователем. Физического удаления записей при этом не происходит, записи лишь помечаются, как удалённые. Для картотеки версии 1 к имени и описанию сайта карточки добавляется пометка «(deleted)». Отмеченные к удалению записи не выводятся в списке карточек. |
|
Восстановление удалённой карточки |
Методика восстановления зависит от версии картотеки. Версия 1:
Версия 2:
|
|
Закрытие карточки |
Выполняется нажатием кнопки «Закрыть». Все внесённые изменения теряются. |
4. Объекты, использующие данные картотеки
4.1 Утилита командной строки hseDigger.exe
Предназначена для поиска объектов, использующих данные картотеки в соответствии с ранее сформированными заявками.
Для управления утилитой используется конфигурационный файл hseDigger.exe.config:
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<configSections>
<section name="Requests" type="System.Configuration.NameValueSectionHandler" />
<section name="RequestFields" type="System.Configuration.NameValueSectionHandler" />
<section name="SearchResult" type="System.Configuration.SingleTagSectionHandler"/>
</configSections>
<RequestFields>
<add key="wpID" value=""/>
<add key="Class" value=""/>
<add key="Field" value=""/>
<add key="SearchCardTemplate"





