スクリプト
概要¶
標準機能では実現できないUI操作等をAjaxのPOSTリクエストで可能にするために、サイト毎に適用可能なJavaScriptを設定することができます。
下記にはその追加方法、権限に関する注意事項、現在利用できる関数の一覧を記載します。
スクリプトの追加方法¶
(この操作は「サイトの管理権限」が必要です。)
- 対象のテーブルを開きます。
- 「管理」メニューからテーブルの管理をクリックします。
- スクリプトタブを開きます。
- 「新規作成」ボタンをクリックします。
- 下表の項目を入力/設定します。
- 「追加」ボタンをクリックします。
- 画面下部の「更新」ボタンをクリックします。
| 項目名 | 説明 | 設定方法 |
|---|---|---|
| タイトル | スクリプトのタイトル | 任意のタイトルを入力 |
| スクリプト | スクリプトの内容 | 任意のスクリプトを入力 |
| 無効 | スクリプトを無効にする場合チェック | チェックボックスで設定 |
| 出力先 | 出力先の画面を選択 | チェックボックスで設定 |
スクリプトの権限に関する注意事項¶
スクリプトはログインユーザの権限で実行されます。実行にあたり特定のユーザやシステム管理者の権限が必要な場合、そのユーザのAPIキーを指定する必要があります。
スクリプトの関数一覧¶
サイト情報取得系スクリプト¶
| No | 関数名 | 説明 |
|---|---|---|
| 1 | $p.tableName | テーブルタイプを取得する関数です。 |
| 2 | $p.controller | コントローラータイプを取得する関数です。 |
| 3 | $p.action | アクションタイプを取得する関数です。 |
サイト情報更新系スクリプト¶
| No | 関数名 | 説明 |
|---|---|---|
| 1 | $p.set | 画面上の値変更と$p.dataへの格納を同時に行う関数です。 |
サイトメッセージ系スクリプト¶
| No | 関数名 | 説明 |
|---|---|---|
| 1 | $p.clearMessage | 画面下に表示されるメッセージを削除する関数です。 |
| 2 | $p.setMessage | 画面下にメッセージを表示させる関数です。 |
コマンド操作やユーザ・組織・グループ操作などのスクリプト¶
| No | 関数名 | 説明 |
|---|---|---|
| 1 | $p.apiUrl | APIリクエストのURL値の取得を行う関数です。 |
| 2 | $p.apiGet | レコードを取得する関数です。 |
| 3 | $p.apiCreate | レコードを作成する関数です。 |
| 4 | $p.apiUpdate | レコードを更新する関数です。 |
| 5 | $p.apiUpsert | レコードを追加または更新する関数です。 |
| 6 | $p.apiDelete | レコードを削除する関数です。 |
| 7 | $p.apiBulkDelete | レコードを一括削除する関数です。 |
| 8 | $p.apiGetSite | サイト情報を取得する関数です。 |
| 9 | $p.apiCreateSite | サイトを作成する関数です。 |
| 10 | $p.apiUpdateSite | サイトを更新する関数です。 |
| 11 | $p.apiDeleteSite | サイトを削除する関数です。 |
| 12 | $p.apiGetClosestSiteId | サイト名検索で該当サイトに最も近いサイトIDを取得する関数です。 |
| 13 | $p.apiUsersCreate | ユーザ情報を作成する関数です。 |
| 14 | $p.apiUsersGet | ユーザ情報を取得する関数です。 |
| 15 | $p.apiUsersUpdate | ユーザ情報を更新する関数です。 |
| 16 | $p.apiUsersDelete | ユーザ情報を削除する関数です。 |
| 17 | $p.apiDeptsGet | 組織情報を取得する関数です。 |
| 18 | $p.apiGroupsGet | グループ情報を取得する関数です。 |
| 19 | $p.apiGroupsCreate | グループ情報を作成する関数です。 |
| 20 | $p.apiGroupsUpdate | グループ情報を更新する関数です。 |
| 21 | $p.apiGroupsDelete | グループ情報を削除する関数です。 |
| 22 | $p.apiSendMail | メールを送信する関数です。 |
値の設置/更新/取得/削除系スクリプト¶
| No | 関数名 | 説明 |
|---|---|---|
| 1 | $p.id | レコードのid値を取得する関数です。 |
| 2 | $p.siteId | サイトのId値を取得する関数です。 |
| 3 | $p.loginId | ログインIdを取得する関数です。 |
| 4 | $p.userId | ログインしているユーザのユーザIdを取得する関数です。 |
| 5 | $p.userName | ログインしているユーザの名前を取得する関数です。 |
| 6 | $p.getColumnName | 対象項目のカラム名(データベースの列名)を取得する関数です。 |
| 7 | $p.getControl | 対象の項目名から要素を取得する関数です。 |
| 8 | $p.getField | 対象の項目名からFieldを取得する関数です。 |
| 9 | $p.getGridRow | 一覧画面にてレコードのtrタグ要素を取得する関数です。 |
| 10 | $p.getGridCell | 一覧画面のtdタグの要素を取得する関数です。 |
| 11 | $p.getGridColumnIndex | 一覧画面にてレコードの表示名のデータが何列目にあるか取得する関数です。 |
| 12 | $p.on | 各イベント発生時に任意の処理を実行する事が出来る関数です。 |
イベント発火系スクリプト¶
| No | 関数名 | タイミング | 説明 |
|---|---|---|---|
| 1 | $p.events.on_editor_load | 編集画面を読み込んだ時 | 「編集画面」を読み込んだときに実行する関数です。 |
| 2 | $p.events.on_grid_load | 一覧画面を読み込みだ時 | 一覧画面を読み込んだときに実行する関数です。 |
| 3 | $p.events.on_calendar_load | カレンダーを読み込みだ時 | カレンダーを読み込んだときに実行する関数です。 |
| 4 | $p.events.on_crosstab_load | クロス集計を読み込みだ時 | クロス集計を読み込んだときに実行する関数です。 |
| 5 | $p.events.on_gantt_load | ガントチャートを読み込みだ時 | ガントチャートを読み込んだときに実行する関数です。 |
| 6 | $p.events.on_burndown_load | バーンダウンチャートを読み込みだ時 | バーンダウンチャートを読み込んだときに実行する関数です。 |
| 7 | $p.events.on_timeseries_load | 時系列チャートを読み込みだ時 | 時系列チャートを読み込んだときに実行する関数です。 |
| 8 | $p.events.on_analy_load | 分析チャートを読み込みだ時 | 分析チャートを読み込んだときに実行する関数です。 |
| 9 | $p.events.on_kamban_load | カンバンを読み込みだ時 | カンバンを読み込んだときに実行する関数です。 |
| 10 | $p.events.before_validate | 入力値の検証前 | バリデーションチェックを行う前に実行する関数です。 |
| 11 | $p.events.after_validate | 入力値の検証後 | バリデーションチェックを行った後に実行する関数です。 |
| 12 | $p.events.before_send | データ送信前 | サーバへデータを送信する前に実行する関数です。 |
| 13 | $p.events.after_send | データ送信後 | サーバへデータを送信した後に実行する関数です。 |
| 14 | $p.events.before_set | 画面の更新前 | サーバへデータを送信後、画面内容を更新する前に実行する関数です。 |
| 15 | $p.events.after_set | 画面の更新後 | サーバへデータを送信後、画面内容を更新した後に実行する関数です。 |
