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


Руководство по рабочему процессу соединителя веб-служб для примера REST API

В этой статье описывается развертывание примера REST API для пошагового руководства по настройке веб-службы с помощью источника веб-данных REST API.

Предпосылки

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

  • Устанавливается средство настройки веб-службы.
  • Развернут образец службы REST-источника данных. Скачайте и установите пример из (см. здесь).

Примечание.

Данные JSON должны содержать один объект со свойством, содержащим массив.

{

"EmployeeList":[

{"id":"1","employee_name":"Albano","employee_salary":"22213","employee_age":"37","profile_image":""},{"id":"2","employee_name":"Albano","employee_salary":"22213","employee_age":"37","profile_image":""}

]

}

Настройка обнаружения проектов REST в средстве настройки веб-службы

Ниже показано, как создать проект для источника данных в средстве настройки веб-службы.

  1. Откройте средство настройки веб-службы. Откроется пустой проект SOAP.

    Инструмент настройки веб-сервиса

  2. Выберите файл>Новый>REST-проект.

    Создание нового проекта REST

  3. Слева выберите REST Project и выберите Добавить.

    Выбор проекта REST

  4. На следующей странице укажите следующие сведения:

    • Новое имя веб-службы
    • Адрес (путь URL-адреса REST API)
    • Пространство имен
    • Режим безопасности (тип проверки подлинности)

    службы REST

    На следующем экране показаны примеры для этих значений:

    Примеры значений для службы REST

    Установите режим безопасности на Нет. Задайте адрес на образец JSON-сервера — размещенного в Azure.

  5. Нажмите ОК. Проект REST, указанный в средстве настройки веб-служб.

    проект REST в средстве настройки веб-служб

  6. Следующий шаг — определить вызов REST API и преобразовать его в вызовы Windows Communication Foundation (WCF).

    1. Разверните REST Project и выберите службу RESTSAMPLE.

    2. Выберите Добавить. Вам будет предложено добавить два значения:

      Введите значения для службы REST

      1. Укажите имя. Этот шаг помечен как 3 на снимке экрана.
      2. Введите адреса. Этот шаг помечен как 4 на снимке экрана.
      3. Нажмите ОК. Ресурс REST добавляется в описание службы RESTSAMPLE.
  7. В поле Ресурсы выберите только что добавленный ресурс REST. Добавьте следующий метод:

    Добавление метода REST в ресурса

  8. Выберите метод REST. Обратите внимание, что можно создать несколько методов в одном ресурсе и определить запросы, передаваемые во время выполнения.

  9. Для метода GETALL запросы не требуются. Оставьте значения параметров пустыми. При экспорте или импорте REST API необходимо определить пример запроса или ответа в зависимости от функции. Скопируйте и вставьте результат JSON при переходе к этому образцу.

    снимок экрана страницы метода REST в средстве настройки веб-службы.

  10. Выберите Сохранить. Сохраните проект в C:\Program Files\Microsoft Forefront Identity Manager\2010\Synchronization Service\Extensions.

Примечание.

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

Настройка типов объектов в средстве настройки веб-службы

Ниже показано, как настроить типы объектов для источника данных в средстве настройки веб-службы.

  1. Далее необходимо определить схему пространства соединителя. Это достигается путем создания типа объекта и определения их типов объектов. Щелкните Типы объектов в левой области и нажмите кнопку "Добавить". Это открывается на экране ниже. Добавьте новый тип объекта и укажите имя. Нажмите кнопку ОК.

    снимок экрана: диалоговое окно для создания типа объекта.

  2. При добавлении типа объекта появляется экран, приведенный ниже.

    снимок экрана: добавлен новый тип объекта.

  3. Правая область, соответствующая типу объекта, позволяет поддерживать атрибуты и их свойства для выбранного типа объекта. При нажатии кнопки "Добавить" отображается следующий экран, на котором можно добавить атрибуты.

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

    снимок экрана с полями атрибутов для имени и типа.

  4. Ниже приведённый экран появляется после добавления всех обязательных атрибутов.

    снимок экрана, показывающий завершенные атрибуты для типа объекта.

  5. Тип объекта и атрибуты после создания предоставляют пустые рабочие процессы, которые удовлетворяют операциям, выполняемым в Microsoft Identity Manager (MIM).

Настройка рабочих процессов в средстве настройки веб-службы

Следующим шагом является настройка рабочих процессов для типа объекта. Файлы рабочего процесса — это последовательность действий, используемых соединителем веб-служб во время выполнения. Рабочие процессы используются для реализации соответствующей операции MIM. Средство настройки веб-службы помогает создать четыре разных рабочих процесса:

  • Импорт: импорт данных из источника данных для следующих двух типов рабочих процессов:

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

    • Добавь
    • Удалить
    • Заменить
  • Пароль. Выполнение управления паролями для пользователя (типа объекта). Для этой операции доступны два действия:

    • Установка пароля
    • Смена пароля
  • Проверка подключения: настройте рабочий процесс, чтобы проверить, успешно ли установлено соединение с сервером источника данных.

Примечание.

Эти рабочие процессы можно настроить для проекта или скачать проект по умолчанию из Центра загрузки Майкрософт.

Конструктор рабочих процессов

Конструктор рабочих процессов открывает рабочую область для настройки рабочего процесса по требованию. Для каждого типа объекта (новый /существующий) средство настройки предоставляет узлы для рабочих процессов, поддерживаемых средством.

конструктор рабочих процессов

Конструктор рабочих процессов состоит из следующих элементов пользовательского интерфейса:

  • Узлы в левой панели: они помогают выбрать, какой рабочий процесс вы хотите разработать.

  • Центральный Конструктор Рабочих Процессов: Здесь вы можете перетащить действия для настройки рабочих процессов. Для выполнения различных операций MIM (экспорт, импорт, управление паролями) можно использовать стандартные и настраиваемые действия рабочего процесса .NET Workflow Framework 4. Средство настройки веб-службы использует стандартные и настраиваемые действия рабочего процесса. Дополнительные сведения о стандартных действиях см. в разделе Использование конструкторов действий.

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

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

  • Инструментарий: упаковывает все средства, включая системные и пользовательские действия, а также предопределенные инструкции для проектирования рабочего процесса. Дополнительные сведения см. в разделе набор инструментов.

  • разделы панели инструментов: Панель инструментов имеет следующие разделы и категории:

    • Description: заголовок панели инструментов. Одна вкладка обращается к панели элементов и свойствам выбранного действия рабочего процесса.

    • импорт рабочих процессов: настраиваемые действия для настройки импорта рабочих процессов.

    • Процесс экспорта: пользовательские действия для конфигурации экспортных процессов.

    • Common: настраиваемые действия для настройки любого рабочего процесса.

    • отладка: действия системного рабочего процесса для отладки, предусмотренные в рабочем процессе 4. Эти действия позволяют отслеживать проблемы для рабочего процесса.

    • утверждения: действия системного рабочего процесса, определенные в Workflow 4. Дополнительные сведения см. в разделе Использование конструкторов действий.

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

  • панель задач : Панель задач включает три элемента: переменные, аргументыи импорт. Эти элементы используются в сочетании с действиями рабочего процесса. Дополнительные сведения см. в статье Введение разработчика в Windows Workflow Foundation (WF) в .NET 4.

Настройка полного рабочего процесса импорта в средстве настройки веб-службы

Ниже показано, как настроить полные рабочие процессы импорта для REST API с помощью средства настройки веб-службы.

Предупреждение

Этот пример создает только рабочий процесс. Может потребоваться изменение рабочего процесса, например использование пользовательской логики в API.

  1. Выберите рабочий процесс полного импорта для настройки. Аргументы и Импорты уже определены и специфичны для конкретных действий. Дополнительные сведения см. на следующих экранах.

    аргументы полного импорта рабочих процессов

    импортированные пространства имен

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

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

    активность последовательности

  3. Чтобы добавить переменную, найдите Создать переменную. Введите wsResponse для имени, выберите в раскрывающемся списке тип переменной, а затем выберите "Обзор типов". Отображается диалоговое окно. Выберите сгенерированный>GETALL>Ответ. Оставьте значения Сфера и По умолчанию невыбранными. Кроме того, задайте эти значения с помощью представления свойств .

    ответ по умолчанию

  4. Перетащите еще один конструктор действий последовательности из панели инструментов в уже добавленную последовательность.

  5. Перетащите WebServiceCallActivity, представленный в разделе Common. Это действие используется для вызова операции веб-сервиса, доступной после обнаружения. Это настраиваемое действие и распространено в разных сценариях операций.

    операции имени службы

    Чтобы использовать операцию веб-службы, задайте следующие свойства:

    • имя службы: введите имя веб-службы.

    • имя конечной точки: укажите имя конечной точки для выбранной службы.

    • имя операции: укажите соответствующую операцию для службы.

    • аргумент: выберите аргументы. В следующем диалоговом окне назначьте значения аргументов, как показано на следующем рисунке:

      Назначение аргументов

      Это важно

      Не изменяйте Имя, Направлениеили Тип для аргумента с помощью этого диалогового окна. Если любое из этих значений изменено, действие становится недействительным. Задайте только значение аргумента. Как показано на этом рисунке, задано значение wsResponse.

  6. Добавьте действие ForEach чуть ниже WebServiceCallActivity. Это действие используется для итерации по всем атрибутам (как привязкам, так и не привязкам) типа объекта. При перетаскивании этого действия в область конструктора рабочих процессов он автоматически перечисляет все имена атрибутов для объекта. Задайте необходимые значения на следующем экране:

    операция вызова веб-сервиса

  7. В некоторых случаях может потребоваться открыть generated.dll, которая находится в файле WsConfig. Скопируйте этот файл WsConfig и переименуйте его с расширением .zip. Откройте и извлеките файл generated.dll, используя предпочтительное средство для отражения .NET.

    файл конфигурации

  8. Определите публичное пространство имен для EmployeeList:

    код списка сотрудников

    Затем добавьте этот возврат в рабочий процесс ForEach:

    Добавление списка сотрудников в рабочий процесс ForEach

  9. Перетащите действие CreateCSEntryChangeScope внутрь тела ForEach. Это действие используется для создания экземпляра объекта CSEntryChange в домене рабочего процесса для каждой соответствующей записи при получении данных из целевого источника данных. Перетаскивание этого действия предоставляется на экране ниже. действия CreateAnchorAttribute автоматически наследуются. Обновите значение DN на предпочитаемое доменное имя.

    Создание записи изменения объема деятельности CS

    Примечание.

    Значения привязки и имена объектов зависят от предоставленной веб-службы. На рисунке показан пример.

  10. Перетащите действие CreateAttributeChange ниже действия CreateAnchorAttribute. Количество перетаскиваемых действий равно числу незакрепленных атрибутов. Дополнительные сведения см. на следующем рисунке.

    Создание привязки

    Примечание.

    Чтобы использовать это действие, выберите и назначьте соответствующие поля из раскрывающегося списка и назначьте значения. Для многозначных атрибутов поместите несколько действий CreateValueChangeActivity внутрь действия CreateAttributeChangeActivity.

  11. Сохраните этот проект в расположении %FIM_INSTALL_FOLDER%\Synchronization Service\Extensions. Затем настройте агент управления, как описано в конфигурации MA веб-службы .

    сохранить проект REST

    Проекты по умолчанию следует скачать и сохранить в расположении %FIM_INSTALL_DIR\2010\Synchronization Service\Extensions в целевой системе. Затем проекты отображаются в мастере настройки соединителя веб-службы.

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

    Это важно

    Файл проекта можно сохранить и открыть из любого расположения (с соответствующими привилегиями доступа исполнителя). В мастере соединителя веб-службы, доступ к которому осуществляется через пользовательский интерфейс синхронизации MIM, можно выбрать только файлы проекта, сохраненные в папке Synchronization Service\Extension.

    Пользователю, выполняющему средство настройки веб-службы, требуются следующие привилегии:

    • Полный доступ к папке расширения службы синхронизации.
    • Доступ на чтение к разделу реестра HKLM\System\CurrentControlSet\Services\FIMSynchronizationService\Parameters, через который определяется путь к папке с расширением.

Дальнейшие действия