2021/05/12

MANUAL

開発者向け機能:スクリプト機能

## 概要 標準機能では実現できないUI操作等をAjaxのPOSTリクエストで可能にするために、サイト毎に適用可能なJavaScriptを設定することができます。 下記にはその追加方法と現在利用できるAPIの一覧を記載します。 ## スクリプトの追加方法 (この操作は”サイトの管理権限”が必要です。) 1. 対象のテーブルを開きます。 1. 「管理」メニューから「[テーブルの管理](/manual/table-management)」をクリックします。 1. 「[スクリプト](/manual/table-management-script)」タブを開きます。 1. 「新規作成」ボタンをクリックします。 1. 下表の項目を入力/設定します。 1. 「追加」ボタンをクリックします。 1. 画面下部の「更新」ボタンをクリックします。 |項目名|説明|設定方法| |:---|:---|:---| |タイトル|スクリプトのタイトル|任意のタイトルを入力| |スクリプト|スクリプトの内容|任意のスクリプトを入力| |出力先|出力先の画面を選択|チェックボックスで設定| ## スクリプトの関数一覧 ### サイト情報取得系スクリプト(SiteInfo.js) |No|関数名|説明| |:--:|:---|:---| |1|[$p.tableName]()|テーブルタイプを取得する関数です。| |2|[$p.controller]()|コントローラータイプを取得する関数です。| |3|[$p.action]()|アクションタイプを取得する関数です。| ### サイト情報更新系スクリプト(_Data.js) |No|関数名|説明| |:--:|:---|:---| |1|[$p.getData]()|順次公開予定| |2|[$p.set](/manual/script-set)|画面上の値変更と$p.dataへの格納を同時に行う関数です。| |3|[$p.setGridTimestamp]()|順次公開予定| |4|[$p.setAndSend]()|順次公開予定| |5|[$p.setMustData]()|順次公開予定| |6|[$p.clearData]()|順次公開予定| |7|[$p.toJson](/manual/script-to-json)|JSON文字列に変換を行う関数です。| ### サイトメッセージ系スクリプト(Message.js) |No|関数名|説明| |:--:|:---|:---| |1|[$p.clearMessage](/manual/script-clear-message)|画面下に表示されるメッセージを削除する関数です。| |2|[$p.setMessage](/manual/script-set-message)|画面下にメッセージを表示させる関数です。| ### コマンド操作やユーザ・組織・グループ操作などのスクリプト(_Api.js) |No|関数名|説明| |:--:|:---|:---| |1|[$p.apiUrl](/manual/script-api-url)|APIリクエストのURL値の取得を行う関数です。| |2|[$p.apiGet](/manual/script-api-get)|値の取得を行う関数です。| |3|[$p.apiCreate](/manual/script-api-create)|新規レコード作成を行う関数です。| |4|[$p.apiUpdate](/manual/script-api-update)|レコードの更新を行う関数です。| |5|[$p.apiDelete](/manual/script-api-delete)|サイト、レコード削除をする関数です。| |6|[$p.apiBulkDelete](/manual/script-api-delete)|サイト、レコード一括削除をする関数です。| |7|[$p.apiUsesUrl]|サイトで任意ユーザのAPI実行のためのURLを取得する関数です。| |8|[$p.apiUsesGet](/manual/script-api-users-get)|ユーザ情報を取得する関数です。| |9|[$p.apiUsesUpdate](/manual/script-api-users-update)|ユーザ情報をアップデートする関数です。| |10|[$p.apiUsesDelete](/manual/script-api-users-delete)|ユーザ情報を削除する関数です。| |11|[$p.apiDeptsUrl]()|サイトで任意組織のAPI実行のためのURLを取得する関数です。| |12|[$p.apiDeptsGet]()|組織情報を取得する関数です。| |13|[$p.apiGroupsUrl]()|サイトで任意グループのAPI実行のためのURLを取得する関数です。| |14|[$p.apiGroupsGet]()|グループ情報を取得する関数です。| |15|[$p.apiSendMailUrl]()|APIでメールを送信するためのURLを取得できる関数です。| |16|[$p.apiSendMail](/manual/script-api-send-mail)|メールを送信する関数です。| ### 値の設置/更新/取得/削除系スクリプト(_Elements.js) |No|関数名|説明| |:--:|:---|:---| |1|[$p.id](/manual/script-id)|レコードのid値を取得する関数です。| |2|[$p.siteId](/manual/script-set-id)|サイトのId値を取得する関数です。| |3|[$p.loginId](/manual/script-login-id)|ログインIdを取得する関数です。| |4|[$p.userId](/manual/script-user-id)|ログインしているユーザのユーザIdを取得する関数です。| |5|[$p.userName](/manual/script-user-name)|ログインしているユーザの名前を取得する関数です。| |6|[$p.getColumnName](/manual/script-get-column-name)|対象項目のカラム名(データベースの列名)を取得する関数です。| |7|[$p.getControl](/manual/script-get-control)|対象の項目名から要素を取得する関数です。| |8|[$p.getField](/manual/script-get-field)|対象の項目名からFieldを取得する関数です。| |9|[$p.getGridRow](/manual/script-get-grid-row)|「[一覧画面](/manual/table-grid)」にてレコードのtrタグ要素を取得する関数です。| |10|[$p.getGridCell](/manual/script-get-grid-cell)|「[一覧画面](/manual/table-grid)」のtdタグの要素を取得する関数です。| |11|[$p.getGridColumnIndex](/manual/script-get-column-index)|「[一覧画面](/manual/table-grid)」にてレコードの表示名のデータが何列目にあるか取得する関数です。| |12|[$p.on](/manual/script-on)|各イベント発生時に任意の処理を実行する事が出来る関数です。| ### イベント発火系スクリプト(_Event.js) |No|関数名|タイミング|説明| |:---|:---|:---|:---| |1|[$p.events.on_editor_load](/manual/script-events-on-editor-load)|編集画面を読み込んだ時|「編集画面」を読み込んだときに実行する関数です。| |2|[$p.events.on_grid_load](/manual/script-events-on-grid-load)|一覧画面の読み込みだ時|「[一覧画面](/manual/table-grid)」を読み込んだときに実行する関数です。| |3|[$p.events.before_validate](/manual/script-events-before-validate)|入力値の検証前|バリデーションチェックを行う前に実行する関数です。| |4|[$p.events.after_validate](/manual/script-events-after-validate)|入力値の検証後|バリデーションチェックを行った後に実行する関数です。| |5|[$p.events.before_send](/manual/script-events-before-send)|データ送信前|サーバへデータを送信する前に実行する関数です。| |6|[$p.events.after_send](/manual/script-events-after-send)|データ送信後|サーバへデータを送信した後に実行する関数です。| |7|[$p.events.before_set](/manual/script-events-before-set)|画面の更新前|サーバへデータを送信後、画面内容を更新する前に実行する関数です。| |8|[$p.events.after_set](/manual/script-events-after-set)|画面の更新後|サーバへデータを送信後、画面内容を更新した後に実行する関数です。|
このページをシェアする