オープンソースWebDBのプリザンター(pleasanter)ブログ

オープンソースのWebDBのプリザンター(pleasanter)のブログとサービス情報サイトです

カテゴリ : お知らせプリザンターとは?使い方スクリプト・スタイル環境構築事例動画

【サーバスクリプト】設定方法とスクリプトの実行タイミングごとのオブジェクトのまとめ

こんにちは。
リーデックス小川です。

 最近は夜の晩酌をあまりしなくなりました。その代わりに炭酸水をよく飲むようになったのですが、種類により味が違うことがわかりました。個人的においしいと思う炭酸水は、ウィルキンソンとサントリーの天然水スパークリングです。

さて、今回はサーバスクリプトについて書いていきたいと思います。サーバスクリプトの設定方法と実行タイミングごとのオブジェクトのまとめを書いていきたいと思います。

サーバスクリプトについては、以前にも記事にしていますので、まだ見ていない方はぜひご覧ください。
pleasanter.hatenablog.jp

 

 

 サーバスクリプトの設定方法(画面)

サーバスクリプトはスクリプト同様に、管理画面より設定できます。画面右上「管理」→「テーブル管理」より、タブ「サーバスクリプト」をクリックしてください。

f:id:h-ogawa-reedex-co-jp:20210123225220p:plain

 

新規作成ボタンをクリックすると、下記の様な画面が表示されます。

f:id:h-ogawa-reedex-co-jp:20210123225250p:plain

 

既存のスクリプトと同じような画面が表示されますね。タイトル、スクリプトは既存のスクリプトと同様です。違いは、既存のスクリプトでは、実行される「画面」を選択するのですが、サーバスクリプトでは実行される「条件」を選択します。

サーバスクリプトは、この条件により、利用できる「オブジェクト(やメソッド)」が異なります。次に、この「オブジェクト」についてみていきます。

 

条件(スクリプトの実行タイミング)ごとに使用可能なオブジェクト

f:id:h-ogawa-reedex-co-jp:20210123234112p:plain


サーバスクリプトは「条件(スクリプトの実行タイミング)」ごとに使用できるオブジェクトが異なります。それぞれ、下記のようなものがあります。

  • 全ての「条件」共通で使えるオブジェクト
  • 「サイト設定の読み込み時」でのみ使えるオブジェクト
  • 「ビュー処理時」でのみ使えるオブジェクト
  • 「画面表示の前」でのみ使えるオブジェクト
  • 「画面表示の前」「計算式の前/後」「作成前/後」「更新前/後」「削除前/後」で使えるオブジェクト

 

全ての「条件」共通で使えるオブジェクト

共通で利用できるオブジェクトとして、下記が挙げられます。

  • ユーザ情報を取得するcontextオブジェクト、
  • 編集画面でレコードの項目を書き換えるmodelオブジェクト、
  • 一覧画面で取得するレコードを絞り込むColumnFilterHashオブジェクトなど

詳細は、公式マニュアルの全ての「条件」共通で使えるオブジェクトをご覧ください。

「サイト設定の読み込み時」でのみ使えるオブジェクト

上記条件で利用できるオブジェクトは下記があります。

  • サイト設定を取得、編集できるsiteSettingsオブジェクト

詳細は、公式マニュアルのsiteSettingsオブジェクトをご覧ください。

「ビュー処理時」でのみ使えるオブジェクト

上記条件で利用できるオブジェクトは下記があります。

  • 項目名を指定して取得するレコードを絞り込むview.Filtersオブジェクト
  • 項目名を指定して取得したレコードの並び替えを行うview.Sortersオブジェクト

詳細は、公式マニュアルのviewオブジェクトをご覧ください。

「画面表示の前」でのみ使えるオブジェクト

上記条件で利用できるオブジェクトは下記があります。

  • セルCSSやフィールドCSSの追加や、項目の非表示設定ができるcolumnsオブジェクト

詳細は、公式マニュアルの「画面表示の前」でのみ使えるオブジェクトをご覧ください。

「画面表示の前」「計算式の前/後」「作成前/後」「更新前/後」「削除前/後」で使えるオブジェクト

上記条件で利用できるオブジェクトは下記があります。

  • レコードの読み取りができるmodelオブジェクト
  • 項目の設定情報を取得、編集ができるcolumnsオブジェクト
  • レコードの作成・更新・削除や、指定した数値項目の合計最大値などを取得ができるitemsオブジェクトを使用できます。

詳細は、公式マニュアルの「画面表示の前」「計算式の前/後」「作成前/後」「更新前/後」「削除前/後」で使えるオブジェクトをご覧ください。

 

 

まとめ

今回は、サーバスクリプト設定方法とスクリプトの実行タイミングごとのオブジェクトのまとめについて書いてみました。なんだか、いろいろできそうで楽しみですね。既存のスクリプトよりも簡単に制御できる、スクリプトではできないことがサーバスクリプトではできる、ということなので、このブログでもこの後具体的なサンプルを作成していきたいと思います。

弊社では、スクリプトやスタイルを利用したカスタマイズについてご支援させていただいております。スクリプトについて相談したい、業務を改善のために実現したい機能がある、や、本記事や過去の記事のスクリプトを応用したい、などありましたら、お気軽にお問合せください。

それでは、今回はこの辺で。
最後までご覧いただき、ありがとうございました。