$ps.file.createSection
概要¶
サーバスクリプトで$ps.fileを使用して指定セクションを作成します。
前提条件¶
Script.jsonのDisableServerScriptFileを false に設定することが必要です。
構文¶
パラメータ¶
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
| section | string | ○ | セクション名。セクションについては$ps.fileの「セクションについて」を参照ください。 |
戻り値¶
セクションを作成できた場合は true、作成できなかった場合は false を返却します。
例外¶
C#内で例外が発生した場合はサーバスクリプト内に例外クラス名とエラーメッセージをErrorオブジェクトに入れて例外を発生させます。
使用例¶
以下の例では、Webサーバ内の指定セクションを作成します。
JavaScript¶
サンプルコード¶
1. 案件を受注にしたとき、案件のファイル置き場とフォルダを作る
案件を「受注」にしたとき、案件コードの名前のセクション(ファイル置き場)を$ps.file.createSectionで作り、その下に受領した資料(received)・作業中(work)・提出した版(submitted)のフォルダを$ps.file.createDirectoryで作ります。
実務での使いどころ¶
案件ごとのファイルを、決まったフォルダの形でサーバに置く運用に使えます。受注のたびに人がフォルダを作ると、名前の付け方や形がそろいません。案件コードから作るので、どの案件の置き場かがすぐにわかります。標準の添付ファイルはレコードに付けて保存するもので、サーバのフォルダを決まった形で作ったり、移したり、消したりはできません。
事前準備¶
1:Script.jsonのDisableServerScriptFileをfalseにし、ServerScriptFilePathを設定して、プリザンターを再起動してください($ps.fileの前提条件)。案件のファイル置き場は、このフォルダの下に案件コードの名前のセクションとして作られます。
2:「案件管理」テーブル(期限付きテーブル)で、以下を設定し、エディタに表示してください。
| 項目コード | 内容 |
|---|---|
| 分類A(ClassA) | 案件コード(半角英数字と_・-・.) |
| 状況(Status) | 「100,見積中」「200,受注」「300,提出」「900,完了」「920,失注」 |
3:「案件管理」テーブルにサーバスクリプトを登録します。
3-1:「テーブルの管理 > サーバスクリプト」タブで「新規作成」を選択する。
3-2:タイトル: 任意の名前(例:createProjectFolders)
3-3:スクリプト: 下記サンプルコードを貼り付け
3-4:条件: 「更新前」にチェック
JavaScript¶
// 「受注」の状況の値と、案件のファイル置き場(セクション)の下に作るフォルダ
const ORDERED = 200;
const FOLDERS = ['received', 'work', 'submitted']; // 受領した資料・作業中・提出した版
// 案件を受注にしたとき、案件コード(分類A)の名前でファイル置き場とフォルダを作る
function createProjectFolders() {
// saved は更新前の値。受注の案件を保存し直したときは何もしない
if (model.Status !== ORDERED || Number(saved.Status) === ORDERED) {
return;
}
const section = model.ClassA;
// セクション名とフォルダ名に使えるのは、半角英数字と _ - . のみ(日本語などは例外になる)
if (!/^[A-Za-z0-9_.-]+$/.test(section || '')) {
context.Error('案件コードは、半角英数字と _ - . で入力してください。');
return;
}
// セクションがすでにあっても true が返る(受注をやり直しても、中のファイルは消えない)
if (!$ps.file.createSection(section)) {
context.Error(`ファイル置き場(${section})を作れませんでした。`);
return;
}
for (const folder of FOLDERS) {
if (!$ps.file.createDirectory(section, folder)) {
context.Error(`フォルダ(${section}/${folder})を作れませんでした。`);
return;
}
}
}
createProjectFolders();
注記¶
- セクションがすでにあっても
createSectionはtrueを返し、中のファイルは消えません。受注をやり直しても安全です。 createDirectoryは、途中のフォルダが無ければまとめて作ります(例:a/b/c)。- 状況が「受注」に変わる更新のときのみ動きます。APIで状況を変えたときも動きます。
- セクション名・フォルダ名に使えるのは、半角英数字と
_・-・.のみです。日本語などを使うと例外になるため、案件コードを先に確かめています。 - 「案件のファイル置き場」のサンプルは4本あり、同じ「案件管理」テーブルに並べて使えます:createSection(受注)・copyFile(提出)・moveDirectory(完了)・removeSection(失注)。同じ条件のサーバスクリプトはまとめて実行されるため、ファイルの先頭で宣言する名前が重ならないようにしています。
対応バージョン¶
| 対応バージョン | 内容 |
|---|---|
| 1.4.12.0 以降 | 機能追加 |
