既存のコンテンツのヘルプセンターへの移行

この記事では、既存のコンテンツを新しいヘルプセンターのナレッジベースおよびコミュニティに移行するプロセスの概要について説明します。

次のトピックについて説明します。

• ナレッジベースにコンテンツを移行する
• コミュニティにコンテンツを移行する

ナレッジベースにコンテンツを移行する

外部システムからヘルプセンターへのコンテンツの移行は、1つのステップからのデータが後続のステップに必要とされる多段階プロセスです。

計画は重要です。レガシーコンテンツの構造をヘルプセンターの3層構造にマッピングする必要があります。

作成者をZendeskユーザーとしてインポートする

まず、すべての記事の作成者をZendeskユーザーとしてインポートします。ヘルプセンターの記事の作成者は、「エージェント」のロールを持つZendeskユーザーである必要があります。ヘルプセンターの記事の作成者は、「エージェント」のロールを持つZendeskユーザーである必要があります。「Zendesk Supportのユーザーロールの概要」を参照してください。

APIを使用してZendeskユーザーを作成するには、Zendesk APIドキュメントの「Create User（ユーザーの作成）」を参照してください。各POSTリクエストでrole属性を必ず"agent"に設定してください。

ユーザーの作成に成功すると、ZendeskはJSONレスポンスでユーザーの新しいIDを含むユーザーの詳細を返します。

{
  "user": {
    "id":   9873843,
    "name": "Roger Wilco",
    ...
  }
}

各ユーザーIDを記録します。ヘルプセンターで作成した各記事のauthor_id属性を設定するには、IDが必要です。

ヒント：それぞれの作成者IDとそのレガシーの記事のマップを作成することもできます。

ユーザーセグメント内で組織を使用してセクションを分離することを計画している場合は、ユーザーを作成する前に組織を作成する必要があります。組織を作成したら、ユーザーを作成するときに組織IDをユーザーに割り当てます。開発者向けドキュメントの「Create Organization（組織の作成）」を参照してください。ユーザーが複数の組織に所属する場合は、組織のメンバーシップを使用して組織をユーザーレコードに追加します。

ナレッジベースのカテゴリを作成する

ヘルプセンターのAPIドキュメントで「Create Category（カテゴリの作成）」を参照してください。ヘルプセンターのAPIドキュメントで「Create Category（カテゴリの作成）」を参照してください。

カテゴリはセクションの集まりです。カテゴリを作成した後、カテゴリの新しいIDが付けられてJSONレスポンスが返されます。

{
  "category": {
    "id":          37486578,
    "name":        "Super Hero Tricks",
    "description": "This category contains a collection of Super Hero tricks",
    "locale":      "en-us",
    "position":    2,
    ...
  }
}

各カテゴリのIDを記録します。後でセクションを作成する際に、セクションを特定のカテゴリに割り当てるためにこのIDが必要となります。

ユーザーセグメントを作成する（オプション）

ヘルプセンターの特定のセクションへのアクセスを制限したい場合は、そのセクションにユーザーセグメントを割り当てることができます。ヘルプセンターのAPIドキュメントの「Create User Segment（ユーザーセグメントの作成）」を参照してください。

ユーザーセグメントを作成した後、次のように、ユーザーセグメントの新しいIDが付けられてJSONレスポンスが返されます。

{
  "user_segment": {
    "id": 7284
    "name": "VIP agents",
    "user_type": "staff",
    "group_ids": [12, ...],
    "organization_ids": [42, ...],
    "tags": ["vip"],
    "created_at": "2017-05-21T20:01:12Z",
    "updated_at": "2017-05-21T20:01:12Z",
    "built_in": false
  }
}

各ユーザーセグメントのIDを記録します。後でセクションを作成する際に、セクションへのアクセス制限を割り当てるためにこのセグメントIDが必要となります。

カテゴリ内にセクションを作成する

ヘルプセンターのAPIドキュメントで「Create Section（セクションの作成）」を参照してください。セクションは、記事の集まりです。

各POSTリクエストにcategory_idとuser_segment_id（ある場合）を必ず設定してください。Zendeskは、セクションの新しいIDを使用してJSONレスポンスを返します。

{
  "section": {
    "id":          3457836,
    "name":        "Avionics",
    "description": "This section contains articles on flight instruments",
    "locale":      "en-us",
    "category_id": 3465,
    ...
  }
}

各セクションのIDを記録します。後でセクションを作成する際に、記事を特定のセクションに割り当てるためにこのセクションIDが必要となります。

セクション内で記事を作成する

上述の手順のセクションIDとユーザーIDがすべて揃えば、記事を作成できます。ヘルプセンターのAPIドキュメントで「Create Article（記事の作成）」を参照してください。titleとbodyに加えて、各POSTリクエストで必ずauthor_idとsection_idを設定してください。

なお、すべての作者が自動的に、自分が作成した記事について更新を受信するよう登録されます。ヘルプセンターが有効になっている場合は、記事が作成されたときにメール通知が届きます。

Zendeskは次のようなJSONレスポンスを返します。

{
  "article": {
    "id":                37486578,
    "author_id":         3465,
    "promoted":          false,
    "position":          42,
    "comments_disabled": true,
    "section_id":        98838,
    ...
  }
}

添付ファイルをアップロードする（必要な場合）

Amazon S3などのパブリックファイルサーバーでホストされていないインライン画像が記事に含まれている場合は、その画像をヘルプセンターにアップロードします。開発者向けドキュメントの「Create Unassociated Attachment（関連付けられていない添付ファイルの作成）」を参照してください。必ずinlineパラメータをtrueに設定してください。

Zendeskは添付ファイルのURL（content_url）を含むJSONレスポンスを返します

{
  "article_attachment": {
    "id":           1428,
    "article_id":   null,
    "file_name":    "icon.jpg",
    "content_url":  "https://company.zendesk.com/hc/article_attachments/1428/icon.jpg",
    "content_type": "application/image",
    "size":         58298,
    "inline":       true
  }
}

content_urlを使用して、記事のHTML内の画像のURLを更新します。

「Associate Attachments in Bulk to Article（添付ファイルを記事へ一括で関連付ける）」も参照してください。

記事のコメントをインポートする

コメントをインポートするには、作成者IDと記事のIDが必要です。エージェントとエンドユーザーの両方がコメントの作成者になることができます。開発者向けドキュメントの「Create Comment（コメントの作成）」を参照してください。

なお、コメントの作者は全員が、コメントを付けた記事について更新を受信するよう登録されます。ヘルプセンターが有効になっている場合は、コメントが作成されたときにメール通知が届きます。

コミュニティにコンテンツを移行する

コミュニティコンテンツのインポートには、ナレッジベースのインポートと同じ考慮事項が多数あります。投稿者を投稿に割り当てるには、ユーザーをインポートする必要があります。また、従来のコミュニティコンテンツの構造を、ヘルプセンターコミュニティの2層構造にマッピングする必要があります。

ユーザーセグメントを作成する（オプション）

特定のトピックへのアクセスを制限したい場合は、ユーザーセグメントIDが必要です。開発者向けドキュメントの「Create User Segment（ユーザーセグメントの作成）」を参照してください。後でトピックを作成する際に、トピックにアクセス制限を割り当てるためにこのユーザーセグメントIDが必要となります。

コミュニティにトピックをインポートする

開発者向けドキュメントの「Create Topic（トピックの作成）」を参照してください。該当する場合は、POSTリクエストでuser_segment_idを設定してください。

ZendeskはトピックIDを使用してJSONレスポンスを返します。

{
  "topic": {
    "id":   115000553548,
    "name": "Help Center-Tricks",
    ...
  }
}

各トピックのIDを記録します。後でトピックを作成する際に、投稿を特定のトピックに割り当てるためにこのセクションIDが必要となります。

トピック内の投稿をインポートする

開発者向けドキュメントの「Create Post（投稿の作成）」を参照してください。titleとdetailsに加えて、各POSTリクエストで必ずauthor_idとtopic_idを設定してください。

ナレッジベースの記事とは異なり、コミュニティ投稿の作成者はエージェントまたはエンドユーザーであってもかまいません。

投稿を作成すると、作成者はそのトピックのすべての更新を受信するように自動的に登録され、新しい投稿が作成または更新されたときに通知が届きます。

そのトピックのすべての受信登録者に、投稿が作成されたときにメール通知が届きます。投稿を一括インポートするときに通知によって受信登録者が煩わされないようにするには、POSTリクエストに、falseの値を指定したnotify_subscribersパラメータを含めます。

{
  "post": {
    "id":        35467,
    "author_id": 89567,
    "title":     "Help!",
    "details":   "My printer is on fire!",
    "notify_subscribers": false,
    ...
  }
}

投稿へのコメントをインポートする

投稿を作成してIDを取得した後は、関連するコメントを追加できます。開発者向けドキュメントの「Create Comment（コメントの作成）」を参照してください。

コメントは一度に1つだけ作成できます。投稿のコメントを作成すると、コメント作成者はそのトピックのすべての更新を受信するように自動的に登録され、新しい投稿が作成または更新されたときに通知が届きます。

そのトピックのすべての受信登録者に、コメントが作成されたときにメール通知が届きます。通知によって受信登録者が煩わされないようにするには、POSTリクエストに、falseの値を指定したnotify_subscribersパラメータを含めます。