Short.io のデータを帳票ツールbiz-Stream で連携利用する方法
biz-Stream は、多様な表現が可能なWeb 帳票ソリューションです。
この記事では、biz-Stream からCData JDBC ドライバ経由でShort.io のデータにリアルタイムで連携接続して帳票から利用する方法を紹介します。CData Drivers を使うことで、RDB のようにbiz-Stream 内でShort.io のデータを扱うことができるようになります。
biz-Stream へのShort.io JDBC ドライバーの配置
デフォルトの内容でインストールした場合、以下のパスに jar ファイルが配置されますので、その jar ファイルを biz-Stream の所定のパスにコピーします。
- cdata.jdbc.api.jar
- cdata.jdbc.api.lic (試用版では.lic ファイルは不要)
- コピー元:C:\Program Files\CData\CData JDBC Driver for API 20xxJ\lib
- コピー先:C:\Program Files (x86)\brainsellers\biz-Stream レイアウト・デザイナ\lib_jdbc
biz-Stream からShort.io への接続設定
レイアウトデザイナを起動後、リソース定義にて Short.io への接続設定を行います。ドライバー選択のプルダウンに CData API JDBC Driver が表示されますので選択します。
API キー認証の設定
Short.io は API キー認証を使用します。API キーを取得するには、以下のステップで進めます:
- Short.io アカウントにログインします
- Settings > Integrations & API > API に移動します
- Create API Key をクリックして API キーをコピーします
API キーを取得したら、接続を確立できます:
- AuthScheme:APIKey に設定します。
- APIKey:Settings > Integrations & API > API から取得した Short.io の API キーに設定します。
接続文字列の例:
Profile=C:\profiles\ShortIo.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';
利用可能なテーブル
Short.io プロファイルでは、以下のテーブルにアクセスできます:
- Domains - 認証済みアカウントに関連付けられた Short.io ドメイン
- Links - ドメインの短縮リンク
- LinkExpand - ドメインとパスから短縮リンクを展開
- LinksByOriginalUrl - 指定した元の宛先 URL に一致する複数の短縮リンクを取得
- Folders - 特定のドメイン内のリンクフォルダー
- LinkPermissions - ドメイン内の特定のリンクの権限レコード
- CountryTargeting - 特定の短縮リンクの国別リダイレクトターゲティングルール
- RegionTargeting - 特定の短縮リンクの地域別リダイレクトターゲティングルール
- Regions - 指定した国コードに対する利用可能な地域/州の一覧
- DomainStatistics - Short.io ドメインのクリック数とトラフィックの集計統計
- LinkStatistics - 特定の Short.io リンクのクリック数とトラフィックの集計統計
サーバURLは以下の形式で入力します。
URL:
jdbc:api:Profile=C:\profiles\ShortIo.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';
JDBC Driver の接続文字列デザイナーを使う
JDBC 接続文字列を作るには、Short.io JDBC Driver のビルトイン接続文字列デザイナーを使う方法があります。ドライバーの.jar ファイルをダブルクリックするか、コマンドラインから.jar ファイルを実行します。
Windows:
java -jar 'C:\Program Files\CData\CData JDBC Driver for API 20xxJ\lib\cdata.jdbc.api.jar'
MacOS:
java -jar cdata.jdbc.api.jar
接続プロパティに値を入力して、生成される接続文字列をクリップボードにコピーします。
次にデータ取得条件を設定します。SQL 定義から定義名を設定し、編集ボタンをクリックします。
上のグレーエリアで右クリック → テーブルリストと選択しますと、Short.io のオブジェクトがリストで表示されます。使用するテーブルを選択します。
ここでは取得対象の項目や条件などを設定することができます。対象項目や条件を指定できたらOKボタンをクリックし、戻った画面で追加ボタンをクリックします。
最後にデータソース設定を行います。データソース定義名に先ほど設定したものを選択し、画面下部にある追加ボタンをクリックします。これでbiz-Stream でShort.io のデータを利用する準備ができました。
Short.io のデータをリアルタイムで参照するbiz-Stream 帳票のデザイン
用紙設定を行います。今回は A4 設定にしました。設定後は画面下部にある追加ボタンをクリックします。
ページ設定では新規ボタンをクリックします。
ここではレイアウトデザイナが帳票テンプレートを xml で保存しますので、ファイル名を設定します。
レイアウトにはさまざまなメニューがありますが、今回は表を使用します。表を設定後、Short.io から取得したデータをセットするエリアを作成します。各セルにテキストボックスを挿入し、そのテキストボックス自体に Short.io の項目を紐づけします。
※ヘッダーにもそれぞれテキストボックスを追加します。
レイアウト作成画面を閉じた後、ページ設定の画面に戻りますので、画面下部にある追加ボタン(一度作成している場合は適用)をクリックし、レイアウトの作成が完了となります。
レイアウトデザイナーのトップ画面のヘッダーメニューからプレビューアイコンをクリックします。先ほど作成したレイアウトで Short.io のデータを表示させることができます。
このようにCData JDBC ドライバをアップロードすることで、簡単にbiz-Stream でShort.io のデータをリアルタイムに参照する帳票をノーコードで連携して作成することができます。
ぜひ、CData JDBC Driver for API 30日の無償評価版 をダウンロードして、お試しください。