コンテンツ管理の構成

コンテンツ管理を構成することで、 開発者ポータルでコンテンツ・タイプのレビューと承認のプロセスを構成できます。 ロールに適切な許可を割り当てることで、各ロールが実行できるアクションを指定できます。

開始前に

コンテンツ・モデレーションを構成するユース・ケースの例としては、 開発者ポータルで公開される前に、プロフェッショナル文書作成者が API 文書をレビューする場合があります。 ライターは、例えば、API 開発者に、タイプミスがあることを通知したり、操作説明の改善を提案したり、イメージ・ファイルを添付したりします。 その後、文書が API に再公開されてから 開発者ポータルに公開される前に、編集が行われる可能性があります。

このタスクを実行するには、 開発者ポータル を有効にして、管理者権限を持っている必要があります。

このタスクについて

コンテンツ管理を使用することで、 開発者ポータル ・サイトのワークフローを構成して、API や製品などのコンテンツ・タイプを管理できるようにすることができます。 ただし、コンシューマー組織とコンシューマー・アプリケーションは管理できません。

手順

  1. 開発者ポータル に管理者としてログインします。
  2. 管理者ダッシュボードが表示されない場合は、 「管理」 をクリックして表示します。
  3. 必要なモジュールを有効にします。
    1. 管理者ダッシュボードで、 「拡張」をクリックします。
    2. 検索バーに workflowsと入力し、 「ワークフロー」 モジュールを選択して 「有効」をクリックします。
    3. 検索バーに content moderationと入力し、 「コンテンツ管理」 モジュールを選択して、 「有効化」をクリックします。
  4. 構成 > ワークフロー > ワークフロー にナビゲートします。
  5. Editorial がワークフローとしてリストされていることを確認します。 リストされていない場合は、以下のようにします。
    1. + Add workflowをクリックします。

      ワークフローの追加画面を示す画面キャプチャー

    2. ラベルとして Editorial を入力します。
    3. ワークフロー・タイプ Content moderationを選択します。
    4. Saveをクリックします。
  6. ワークフローをセットアップします。
    1. Editorial ワークフローで Edit をクリックします。
    2. Add a new state リンクをクリックします。

      状態の追加画面を示す画面キャプチャー

    3. State label フィールドに値 Review を入力し、 Published チェック・ボックスと Default revision チェック・ボックスをクリアしたままにして、 「保存」をクリックします。

      状態の詳細画面を示す画面キャプチャー

    4. review 状態を Draft 状態と Published 状態の間にドラッグし、「保存」をクリックします。 ドラッグ・ハンドルが表示されていない場合は、 STATES セクションの Hide row weights リンクをクリックして、ドラッグ・ハンドルが表示されるようにします。

      レビュー状態の位置変更を示す画面キャプチャー

    5. Add a new transition リンクをクリックします。
    6. Transition Label フィールドに値 Review を入力し、 From セクションの Draft チェック・ボックスにチェック・マークを付けて、 To セクションの Review をクリックし、 「保存」をクリックします。
    7. Review 遷移を Create New Draft 遷移と Publish 遷移の間にドラッグし、 「保存」をクリックします。
    8. Create New Draft 遷移で Edit 操作をクリックします。
    9. From チェック・ボックス・リストで、 Published チェック・マークを外して、 Review 「保存」をクリックします。
    10. Publish 遷移で Edit 操作をクリックします。
    11. From チェック・ボックス・リストで、 Draft チェック・マークを外して、 Review 「保存」をクリックします。
    12. THIS WORKFLOW APPLIES TO セクションの Content types 項目に対して Select をクリックします。
    13. Product コンテンツ・タイプを選択し、 「保存」をクリックします。
  7. ワークフローの許可スキーマをセットアップします。
    1. ユーザー > 「役割」 > 「新規役割の追加」をクリックします。
    2. Role Name フィールドに値 Editor を入力し、 「保存」をクリックします。
    3. Editor 役割を Content Author 役割と Administrator 役割の間にドラッグし、 「保存」をクリックします。
    4. 「権限」タブをクリックし、 Content Moderation 権限セクションまでスクロールダウンします。
    5. EDITOR 役割の場合は、 Content Moderation セクションですべての許可を選択します。
    6. 「コンテンツ作成者」役割の場合は、権限 Editorial workflow: Use Create New Draft transitionView any unpublished contentを選択し、 View the latest version 「権限の保存」をクリックします。
    7. EDITOR 役割と CONTENT AUTHOR 役割に権限があることを確認します Use the administration toolbar
  8. ポータルでユーザーに許可を割り当てます。 ポータルに登録済みユーザーがまだいない場合は、新規コンシューマー組織を作成し、そこに 2 人の新規ユーザーを招待します。
    1. 「ユーザー」をクリックします。
    2. リスト内のいずれかのユーザー (管理ユーザーではない) の横にあるチェック・ボックスにチェック・マークを付け、 Action ドロップダウンから Add the Content Author role to the selected user(s) を選択して、 Apply to selected itemsをクリックします。
    3. リスト内の別のユーザー (admin ユーザーではない) の横にあるチェック・ボックスにチェック・マークを付け、 Action ドロップダウンから Add the Editor role to the selected user(s) を選択して、 Apply to selected itemsをクリックします。

結果

開発者ポータルでコンテンツ管理が正常に構成されました。 これで、API Manager ユーザー・インターフェースを使用して製品をポータルに公開し、製品をドラフト状態からレビュー状態に遷移することができるようになりました。