拡張SQL

概要¶

拡張SQLは、プリザンターがデータベースに対して発行するSQL処理を、プログラミングによってカスタマイズする機能です。

1. レコードの作成前、更新後などのデータ反映時のタイミングで任意のSQLを追加、実行することができる
   

   ［例］レコードの新規作成のタイミングで、別テーブルのレコードを更新
   

2. リンクサーバ（SQL Server）またはDBリンク（PostgreSQL）を利用することで、別システムのデータベースに対してSQLを実行できる
   

3. プリザンター内で発生するイベントに対して、対象をWhere句やOrderBy句で制御できる
   

   ［例］レコードのアクセス制御を利用せず、より細かい条件でレコード単位のアクセス制御を実現  
   ［例］特定グループのメンバーのみ二段階認証をスキップ
   

4. APIから呼び出して実行できる
   

   ［例］スクリプト、サーバスクリプトからデータベース内のデータを直接取得・更新する処理を実装
   

拡張SQLの実行¶

拡張SQLは、SQLにプリザンターへの登録に必要な情報を添え、JSON形式のパラメータファイルとして専用のフォルダへ配置することで登録できます。

登録した任意の拡張SQLを実行する方法は2つに大別できます。

1. プリザンター内で発生するイベントに紐付けして実行する方法
2. 任意のタイミングで、サーバスクリプトまたはAPIから呼び出して実行する方法

このページでは前者の実行方法について説明します。後者の方法の詳細は、以下の各ページを確認してください。

サーバスクリプト¶

1. 開発者ガイド：サーバスクリプト：extendedSql
2. 開発者ガイド：サーバスクリプト：view
3. 開発者ガイド：サーバスクリプト：view.OnSelectingWhere

API¶

1. 開発者ガイド：拡張機能：拡張SQL：APIから拡張SQLを実行する

注意事項¶

1. 本機能を誤って使用するとプリザンターを利用できなくなったり、プリザンター内のデータを壊してしまったりする可能性があります。
2. 十分な検証、テストを経たうえで利用してください。
3. APIキーやセッションによるログイン確認は行いますが、テーブルの権限確認は行いません。SQL内で確認が必要です。

制限事項¶

1. 拡張SQLで使用するJSONファイル、SQLファイルの更新は、プリザンターの再起動後に反映されます。
2. セキュリティ上の理由により、拡張SQLはWeb画面からは設定できません。

拡張SQLの設定方法¶

本マニュアルに従ってプリザンターをセットアップしている場合、以下の手順で設定できます。

1. C:\web\pleasanter\Implem.Pleasanter\App_Data\Parameters\ExtendedSqls配下に以下の内容を含むJSONファイルを作成し、プリザンターを再起動してください。
2. ファイルの拡張子は必ず「.json」としてください。
3. ExtendedSqls\配下はフォルダで階層化できます。この場合、配下のすべてのJSONファイルが設定ファイルとして読み込まれます。

JSONファイルのパラメータ¶

基本設定¶

実行対象の絞り込み¶

以下のパラメータは、いずれも省略可能です。

イベントトリガー¶

以下のパラメータは、実行タイミングを制御するイベントトリガーです。

動的制御¶

API連携¶

CommandTextの詳細¶

CommandText内では、以下の変数とプレースホルダーを利用できます。

変数¶

プレースホルダー¶

イベントトリガーOnUseSecondaryAuthenticationをtrueに設定した場合は、利用できません。

外部ファイル化¶

CommandTextの内容を外部ファイルにまとめ、インポートできます。

JSONファイルの「拡張子を含むファイル名」に「拡張子.sqlを追加」したSQLファイルを作成し、JSONファイルと同じディレクトリに配置してください。

例：sample.jsonのCommandTextを外部ファイル化する場合¶

sample.json.sql

ストアドプロシージャの実行¶

拡張SQLからストアドプロシージャを実行する場合には「Implem.Pleasanter_User」にEXECUTE権限を付与してください。

リンクサーバー¶

データベースにSQL Serverを利用している場合は、リンクサーバー機能を使用し、外部のデータベースとの入出力が可能です。

サンプルコード¶

{
    "Description": "Sample",
    "SiteIdList": [2],
    "OnUpdated": true,
    "CommandText": "-- 任意のSQLを記述します"
}

{
      : 省略
    "OnSelectingWherePermissionsUsers": true,
    "CommandText": "(\"Users\".\"Body\" is null or \"Users\".\"Body\"<>'NOLIST')"
}

{
      : 省略
    "OnUseSecondaryAuthentication": true,
    "CommandText": "select 0 from [GroupMembers] where [GroupMembers].[GroupId] = 1 and [GroupMembers].[UserId] = @UserId;"
}

関連情報¶

• 開発者ガイド：サーバスクリプト：extendedSql
• 開発者ガイド：サーバスクリプト：view
• 開発者ガイド：サーバスクリプト：view.OnSelectingWhere
• 開発者ガイド：拡張機能：拡張SQL：APIから拡張SQLを実行する
• テーブルの管理：エディタ：項目の詳細設定：説明