Поделиться через


Пошаговое руководство. Создание и отладка решения рабочего процесса SharePoint

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

В этом пошаговом руководстве рассматриваются следующие задачи:

  • Создание проекта последовательного рабочего процесса определения списка SharePoint в Visual Studio.

  • Создание действий рабочего процесса.

  • Обработка событий действий рабочего процесса.

Примечание.

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

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

Необходимые компоненты

Для выполнения этого пошагового руководства требуются следующие компоненты:

  • Поддерживаемые редакции Microsoft Windows и SharePoint.

  • Visual Studio.

Добавление свойств в библиотеку общих документов SharePoint

Чтобы отслеживать состояние проверки документов в библиотеке общих документов, мы создадим три новых свойства для общих документов на сайте SharePoint: Statusи AssigneeReview Comments. Мы определяем эти свойства в библиотеке общих документов .

Добавление свойств в библиотеку общих документов SharePoint

  1. Откройте сайт SharePoint, например имя> системы http://</SitePages/Home.aspx, в веб-браузере.

  2. На панели QuickLaunch выберите SharedDocuments.

  3. Выберите библиотеку на ленте "Средства библиотеки", а затем нажмите кнопку "Создать столбец" на ленте, чтобы создать новый столбец.

  4. Присвойте столбцу значение "Состояние документа", задайте для параметра " Выбор" (меню для выбора) и укажите следующие три варианта, а затем нажмите кнопку "ОК ".

    • Проверка необходимых

    • Проверка завершена

    • Запрошенные изменения

  5. Создайте еще два столбца и назовите их Назначаемый и просмотр комментариев. Задайте тип столбца Assignee как одну строку текста и тип столбца "Рецензирование примечаний" в виде нескольких строк текста.

Включение редактирования документов без необходимости проверка

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

Включение редактирования документов без их проверка

  1. На панели QuickLaunch выберите ссылку " Общие документы ".

  2. На ленте "Средства библиотеки" выберите вкладку "Библиотека" и нажмите кнопку "Библиотека Параметры", чтобы отобразить страницу Параметры библиотеки документов.

  3. В разделе "Общие Параметры" выберите ссылку "Управление версиями" Параметры, чтобы отобразить страницу Параметры управления версиями.

  4. Убедитесь, что параметр для проверка документов проверка, прежде чем их можно изменить, нет. Если это не так, измените его на "Нет ", а затем нажмите кнопку "ОК ".

  5. Закройте браузер.

Создание последовательного проекта рабочего процесса SharePoint

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

Создание последовательного проекта рабочего процесса SharePoint

  1. Запустите среду Visual Studio.

  2. В строке меню выберите "Файл>нового проекта">, чтобы отобразить диалоговое окно "Новый проект".

  3. Разверните узел SharePoint в Visual C# или Visual Basic, а затем выберите узел 2010.

  4. В области "Шаблоны" выберите шаблон проекта SharePoint 2010.

  5. В поле "Имя" введите MySharePointWorkflow и нажмите кнопку "ОК".

    Откроется мастер настройки SharePoint.

  6. На странице "Указание сайта и уровня безопасности для отладки" нажмите кнопку "Развернуть как решение фермы", а затем нажмите кнопку "Готово", чтобы принять уровень доверия и сайт по умолчанию.

    Этот шаг задает уровень доверия для решения в качестве решения фермы, единственный доступный вариант для проектов рабочих процессов. Дополнительные сведения см. в разделе "Изолированные решения".

  7. В Обозреватель решений выберите узел проекта, а затем в строке меню выберите "Добавить новый элемент проекта>".

  8. В разделе Visual C# или Visual Basic разверните узел SharePoint и выберите узел 2010.

  9. В области шаблонов выберите шаблон последовательного рабочего процесса (только для фермы) и нажмите кнопку "Добавить".

    Откроется мастер настройки SharePoint.

  10. На странице "Указание имени рабочего процесса для отладки" примите имя по умолчанию (MySharePointWorkflow — Workflow1). Сохраните значение типа шаблона рабочего процесса по умолчанию, рабочий процесс списка и нажмите кнопку "Далее ".

  11. В Visual Studio вы хотите автоматически связать рабочий процесс в сеансе отладки? Нажмите кнопку "Далее", чтобы принять все параметры по умолчанию.

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

  12. В разделе "Указание условий запуска рабочего процесса" оставьте параметры по умолчанию в разделе "Как запустить рабочий процесс?" и нажмите кнопку "Готово".

    Эта страница позволяет указать при запуске рабочего процесса. По умолчанию рабочий процесс запускается, когда пользователь вручную запускает его в SharePoint или когда создается элемент, к которому связан рабочий процесс.

Создание действий рабочего процесса

Рабочие процессы содержат одно или несколько действий , представляющих действия для выполнения. Используйте конструктор рабочих процессов для упорядочивания действий для рабочего процесса. В этой процедуре мы добавим два действия в рабочий процесс: HandleExternalEventActivity и OnWorkFlowItemChanged. Эти действия отслеживают состояние проверки документов в списке общих документов

Создание действий рабочего процесса

  1. Рабочий процесс должен отображаться в конструкторе рабочих процессов. Если это не так, откройте файл Workflow1.cs или Workflow1.vb в Обозреватель решений.

  2. В конструкторе выберите действие OnWorkflowActivated1 .

  3. В окне "Свойства" введите onWorkflowActivated рядом с свойством Invoked и нажмите клавишу ВВОД.

    Откроется редактор кода, а метод обработчика событий с именем onWorkflowActivated добавляется в файл кода Workflow1.

  4. Вернитесь к конструктору рабочих процессов, откройте панель элементов и разверните узел рабочего процесса Windows версии 3.0 .

  5. В узле рабочего процесса Windows версии 3.0 панели элементов выполните один из следующих действий:

    1. Откройте контекстное меню для действия "Пока " и нажмите кнопку "Копировать". В конструкторе рабочих процессов откройте контекстное меню для строки в действии onWorkflowActivated1 и нажмите кнопку "Вставить".

    2. Перетащите действие "Пока " из панели элементов в конструктор рабочих процессов и подключите действие к строке под действием onWorkflowActivated1 .

  6. Выберите действие WhileActivity1.

  7. В окне "Свойства" задайте для условия кода условие.

  8. Разверните свойство Condition, введите isWorkflowPending рядом со свойством дочернего условия и нажмите клавишу ВВОД.

    Откроется редактор кода, а метод с именем isWorkflowPending добавляется в файл кода Workflow1.

  9. Вернитесь к конструктору рабочих процессов, откройте панель элементов и разверните узел рабочего процесса SharePoint.

  10. В узле рабочего процесса SharePoint на панели элементов выполните один из следующих наборов действий:

    • Откройте контекстное меню для действия OnWorkflowItemChanged и нажмите кнопку "Копировать". В конструкторе рабочих процессов откройте контекстное меню для строки внутри действия whileActivity1 и нажмите кнопку "Вставить".

    • Перетащите действие OnWorkflowItemChanged из панели элементов в конструктор рабочих процессов и подключите действие к строке внутри действия whileActivity1 .

  11. Выберите действие onWorkflowItemChanged1.

  12. В окне "Свойства" задайте свойства, как показано в следующей таблице.

    Свойство Значение
    CorrelationToken workflowToken
    Вызывается onWorkflowItemChanged

Обработка событий действий

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

Обработка событий действий

  1. В Workflow1.cs или Workflow1.vb добавьте в начало класса следующее Workflow1 поле. Это поле используется в действии для определения завершения рабочего процесса.

    Boolean workflowPending = true;
    
  2. Добавьте приведенный ниже метод в класс Workflow1. Этот метод проверка значение Document Status свойства списка "Документы", чтобы определить, был ли документ проверен. Document Status Если для свойства задано Review Completeзначение , checkStatus метод задает workflowPending поле false, чтобы указать, что рабочий процесс готов к завершению.

    private void checkStatus()
    {
        if ((string)workflowProperties.Item["Document Status"] == "Review Complete")
        workflowPending = false;
    }
    
  3. Добавьте следующий код в onWorkflowActivated метод и onWorkflowItemChanged методы для вызова checkStatus метода. При запуске рабочего процесса метод вызывает checkStatus метод, чтобы определить, onWorkflowActivated был ли документ уже проверен. Если он не был проверен, рабочий процесс продолжается. При сохранении документа метод снова вызывает checkStatus метод, чтобы определить, onWorkflowItemChanged был ли документ проверен. workflowPending Пока для поля задано значение true, рабочий процесс продолжает выполняться.

    private void onWorkflowActivated(object sender, ExternalDataEventArgs e)
    {
        // Check the status.
        checkStatus();
    }
    
    private void onWorkflowItemChanged(object sender, ExternalDataEventArgs e)
    {
        // Check the status.
        checkStatus();
    }
    
  4. Добавьте следующий код в isWorkflowPending метод, чтобы проверка состояние workflowPending свойства. При каждом сохранении документа действие whileActivity1 вызывает isWorkflowPending метод. Этот метод проверяет Result свойство ConditionalEventArgs объекта, чтобы определить, следует ли продолжить или завершить действие WhileActivity1 . Если для свойства задано значение true, действие продолжается. В противном случае действие завершается и рабочий процесс завершается.

    private void isWorkflowPending(object sender, ConditionalEventArgs e)
    {
        e.Result = workflowPending;
    }
    
  5. Сохраните проект.

Тестирование шаблона рабочего процесса SharePoint

При запуске отладчика Visual Studio развертывает шаблон рабочего процесса на сервере SharePoint и связывает рабочий процесс со списком общих документов . Чтобы протестировать рабочий процесс, запустите экземпляр рабочего процесса из документа в списке общих документов .

Тестирование шаблона рабочего процесса SharePoint

  1. В Workflow1.cs или Workflow1.vb установите точку останова рядом с методом onWorkflowActivated .

  2. Выберите ключ F5 для сборки и запуска решения.

    Появится сайт SharePoint.

  3. В области навигации в SharePoint выберите ссылку " Общие документы ".

  4. На странице "Общие документы" выберите ссылку "Документы" на вкладке "Инструменты библиотеки" и нажмите кнопку "Отправить документ".

  5. В диалоговом окне "Отправить документ" нажмите кнопку "Обзор", выберите любой файл документа, нажмите кнопку "Открыть", а затем нажмите кнопку "ОК".

    Это отправляет выбранный документ в список общих документов и запускает рабочий процесс.

  6. В Visual Studio убедитесь, что отладчик останавливается в точке останова рядом с методом onWorkflowActivated .

  7. Выберите клавишу F5, чтобы продолжить выполнение.

  8. Здесь можно изменить параметры документа, но оставить их значениями по умолчанию, нажав кнопку "Сохранить ".

    Возвращается на страницу "Общие документы" веб-сайта SharePoint по умолчанию.

  9. На странице "Общие документы" убедитесь, что значение под столбцом MySharePointWorkflow — Workflow1 имеет значение In Progress. Это означает, что рабочий процесс выполняется и что документ ожидает проверки.

  10. На странице "Общие документы" выберите документ, щелкните стрелку, которая появится, а затем выберите пункт меню "Изменить свойства".

  11. Задайте состояние документа для проверки завершения и нажмите кнопку "Сохранить ".

    Возвращается на страницу "Общие документы" веб-сайта SharePoint по умолчанию.

  12. На странице "Общие документы" убедитесь, что для столбца "Состояние документа" задано значение "Проверка завершена". Обновите страницу "Общие документы" и убедитесь, что для столбца MySharePointWorkflow — Workflow1 задано значение Completed. Это означает, что рабочий процесс завершен и что документ был проверен.

Следующие шаги

Дополнительные сведения о создании шаблонов рабочих процессов см. в следующих разделах: