本記事はCData Software Calendar 2024 18日目の記事です。
こんにちは!CData Software Japan の古川です。ローカライズチームでCData Drivers を担当しています。
製品やサービスを導入する際、機能性はもちろん重要ですが、その機能を最大限に活用するためには充実したドキュメントが大切ですよね。CData 製品はその種類も機能も非常に豊富で、データソースの更新やお客様のご要望に合わせて日々進化しています。もちろん、それに伴い活用を支えるドキュメントも常に最新の情報を提供できるようアップデートしてお届けしています。
この記事では、CData 製品の中から、CData Drivers (現在270種類以上!)を迷わず使いこなすためのドキュメントの歩き方をご紹介します。
ヘルプドキュメントの紹介
ヘルプドキュメントは、製品を最大限に活用するための最も重要なリソースです。CData Drivers のヘルプドキュメントはこちらからアクセスできます。表示されるデータソース一覧から目的のデータソースをクリックし、表示されるページで利用したいエディションの「オンラインヘルプ」をクリックします。
CData Drivers のヘルプドキュメントは以下のような構成です。
- はじめに
- エディション固有の説明
- 高度な機能
- SQL 準拠
- データモデル
- 接続プロパティ
- ソフトウェア使用許諾契約書
例:JDBC Driver for Salesforce のヘルプドキュメント構成
ここからは、CData Drivers の中でも人気の高いJDBC Driver for Salesforce のヘルプドキュメントを例にご紹介していきます。
「はじめに」セクション
「はじめに」セクションには、データソースへの接続・認証方法が詳しく記載されており、お試しいただく際は必須のページです。また、製品を継続してお使いただいている方にとって重要な変更履歴もこのセクションの最後にあります。バージョンアップの際、重要な変更や機能追加の情報はここからご確認ください。
ひとつ今年新たに追加された項目をご紹介します。OAuth のスコープおよびエンドポイントでは、必要なスコープとエンドポイントドメインが一覧で確認できるようになりました。まだ対象製品は限られていますが、これから順次追加される予定です。
「データモデル」セクション
「データモデル」セクションでは、取得可能なテーブル、ビュー、ストアドプロシージャなどがリストされています。これにより、必要なデータが確実に取得できるかを事前に確認することができます。
「接続文字列オプション」セクション
「接続文字列オプション」セクションには、接続の確立に使用できるさまざまなオプションの説明があります。これにより、ユーザーは自分の環境や要件に最適な接続設定を選択することができます。例えば、認証情報の設定方法や、タイムアウトの設定、プロキシの使用方法などが具体的に説明されています。
ヘルプドキュメント以外に情報はあるの?
ヘルプドキュメント以外にも、CData では以下のような情報源を提供しています。
ナレッジベース(KB)
CData では実際に利用したいデータソース × ツールの組み合わせでお試しできるよう、豊富なナレッジベースをご用意しています。ナレッジベースページで利用したいデータソース・ツールを検索することで、具体的な接続方法やデータを取得する方法を知ることができます。
ブログ
日々更新されるHot なトピックやTips はブログページご覧いただけます。最新の機能紹介や、効率的な使い方、業界のトレンドなど、役立つ情報が満載です。
導入事例
導入事例ページでは、実際にCData Drivers を導入いただいた企業様の事例をお読みいただけます。導入に至った業務上の課題から、製品を導入した効果まで、他社の活用方法を参考にすることができます。
さいごに
CData ドライバーは機能面だけでなく、ドキュメントもお客様が使いやすいように変更・更新を日々行っています。ドキュメントについてご不明な点やご意見がございましたら、ぜひフィードバックをお寄せください。皆様のご意見を基に、より良いドキュメントを提供してまいります。明日のアドベントカレンダー19日目は、CData ドキュメントの歩き方 - Apps 編 をご紹介します。ぜひお楽しみに!