こんにちは。
リーデックス小川です。
最近は、だいぶ暖かくなってきました。梅や早咲き桜もピークが過ぎ、桜の開花を待つばかりです。どんちゃん騒ぎができない状況ですので、「花より団子」ではなく「団子より花」で楽しもうと思います。
さて今回は、サーバスクリプトで全ての「条件」共通で使えるオブジェクトについて、わかりやすく解説していきたいと思います。サーバサイドスクリプトについては、本ブログでも紹介していますので、初めての方はぜひご覧ください。
なお、サーバスクリプトはまだ情報が少ないこともあり、調査が追い切れていないことがあることをご了承ください。
条件(スクリプトの実行タイミング)は?
サーバスクリプトには、様々な条件(スクリプト実行タイミング)があります。ある条件でしか使えないオブジェクトがありますが、無条件に利用できるオブジェクトもあります。今回は、すべての条件で利用できるオブジェクトとパラメータについてご紹介していきます。
オブジェクトとパラメータ
それでは、順番にご紹介していきます。
オブジェクト:context
ユーザIDやサイトIDなどの、サイトでユーザが送信したデータの情報を取得することができます。注意点としては、本オブジェクトのデータは取得のみ可能で、値を書き換えることはできないようです。
パラーメータ
このオブジェクトで利用できるパラメータは下記となります。先ほどもご説明しましたが、このオブジェクトのパラメータは変更することができないようです。
値 | 説明 | 変更可否 |
---|---|---|
FormStringRaw | フォーム(項目)に入力した情報 | × |
FormString | フォーム(項目)に入力した情報 | × |
Ajax | Ajaxでリクエストしたかどうかのフラグ | × |
Mobile | Mobileでリクエストしたかどうかのフラグ | × |
ApplicationPath | アプリケーションパス | × |
AbsoluteUri | 絶対URI | × |
AbsolutePath | 絶対パス | × |
Url | URL | × |
UrlReferrer | 前回要求したURL | × |
Query | URLクエリパラメータ | × |
Controller | コントローラ名 | × |
Action | アクション名 | × |
TenantId | テナントID | × |
SiteId | サイトID | × |
Id | レコードID | × |
Groups | グループ情報 | × |
TenantTitle | テナントのタイトル | × |
SiteTitle | サイトのタイトル | × |
RecordTitle | レコードのタイトル | × |
DeptId | 組織ID | × |
UserId | ユーザID | × |
LoginId | ログインID | × |
Language | 設定言語 | × |
TimeZoneInfo | タイムゾーン | × |
HasPrivilege | 付与されている権限 | × |
ApiVersion | APIのバージョン | × |
ApiRequestBody | APIのリクエスト内容 | × |
RequestDataString | リクエストデータ | × |
ContentType | レスポンスヘッダの種類 | × |
サンプル
contextの取得は下記のように行います。
画面でのサンプルは、別の条件で、登録画面や編集画面のサンプルを作成し用途考えていまので、そちらを参考にしていただければと思います。
公式マニュアル・参考サイト
オブジェクト:model
編集画面でレコードの項目を書き換えることができるのがmodelオブジェクトです。
パラーメータ
modelオブジェクトはmodel.XXXと設定します。XXX部分については、項目の表示名とカラム名の対応表 の「カラム名」に対応しているようです。また、読み取り専用については、おそらく設定はできないと思いますが、後ほど検証し、仕様について確認していきたいと考えています。
サンプル
modelの設定は下記のように行います。
画面でのサンプルは、別の条件で、登録画面や編集画面のサンプルを作成し用途考えていまので、そちらを参考にしていただければと思います。
公式マニュアル・参考サイト
オブジェクト:ColumnFilterHash
一覧画面で取得するレコードを絞り込むことができます。
パラーメータ
公式マニュアルなどに現時点で情報がないため、わかり次第追記していきたいと思います。
サンプル
公式マニュアルなどに現時点で情報がないため、わかり次第追記していきたいと思います。
公式マニュアル・参考サイト
公式マニュアルなどに現時点で情報がないため、わかり次第追記していきたいと思います。
まとめ
今回は、サーバスクリプト全ての「条件」共通で使えるオブジェクトついてわかりやすく解説してみました。
情報がまだまだ少なく、調査しきれていないことが多いため、記事内容が薄くなっているかもしれません。今後も情報が入り次第、調査ができ次第、追記していきたいと思います。
弊社では、スクリプトやスタイルを利用したカスタマイズについてご支援させていただいております。スクリプトについて相談したい、業務を改善のために実現したい機能がある、や、本記事や過去の記事のスクリプトを応用したい、などありましたら、お気軽にお問合せください。
それでは、今回はこの辺で。
最後までご覧いただき、ありがとうございました。