コンテンツにスキップ

items.NewSite

概要

サーバスクリプトでサイトに対する「apiModelオブジェクト」の新規インスタンスを作成します。

構文

items.NewSite(referenceType)

パラメータ

パラメータ 型 必須 説明
referenceType string ○ サイト種別を指定。
”Sites”:サイト
"Issues":期限付きテーブル
"Results":記録テーブル
"Wikis":Wiki
"DashBoard":ダッシュボード

戻り値

サイトの「apiModelオブジェクト」を返却します。

使用例①

下記の例では、トップページ(サイトID 0)に"プリザンター"という名称のフォルダを作成します。

JavaScript
let siteId = 0;
let item = items.NewSite("Sites");
item.Title = 'プリザンター';
items.Create(siteId, item);
context.Log(item.SiteId); // 作成したサイトのIDを出力

使用例②

下記の例では、サイトID 2に"課題管理"という名称の「期限付きテーブル」を作成します。items.Createを利用します。

JavaScript
let siteId = 2;
let item = items.NewSite("Issues");
item.Title = '課題管理';
let siteSettings = {}
item.SiteSettings = $ps.JSON.stringify(siteSettings);
items.Create(siteId, item);
context.Log(item.SiteId); // 作成したサイトのIDを出力

使用例③

下記の例では、サイトID 2に"顧客管理"という名称の「記録テーブル」を作成します。apiModel.Createを使用します。

JavaScript
let siteId = 2;
let apiModel= items.NewSite("Results");
apiModel.Title = '顧客管理';
let siteSettings = {}
apiModel.SiteSettings = $ps.JSON.stringify(siteSettings);
apiModel.Create(siteId);
context.Log(apiModel.SiteId); // 作成したサイトのIDを出力

サンプルコード

1. テーブル作成の申請が承認されたら、決めたフォルダの下にテーブルを作る

「テーブル作成申請」のレコードを承認したとき、items.NewSiteで、決めたフォルダの下に、申請のタイトルの名前と分類Aの種類(期限付きテーブル・記録テーブル)のテーブルを作ります。作ったテーブルのサイトIDは、model.UpdateOnExitで申請の分類Bに書き戻します。

実務での使いどころ

テーブルを作れる人(サイトの管理権限を持つ人)を情報システム部門などに絞っている会社で、現場からの「テーブルを作ってほしい」という依頼を、申請と承認の記録を残して受け付けたいときに使えます。承認と同時に決めたフォルダの下にテーブルができるので、作り忘れや置き場所のばらつきを防げます。作ったテーブルのサイトIDが申請に残るので、あとから申請とテーブルを突き合わせられます。プロセスのデータの変更で変えられるのはレコードの項目の値で、テーブルを作ることはできません。

事前準備

1:テーブルを作る先のフォルダを用意し、サイトIDを控えます。

2:「テーブル作成申請」テーブル(記録テーブル)で、以下の項目を有効化してください。

項目コード 内容
タイトル(Title) 作るテーブルの名前
分類A(ClassA) 種類。選択肢一覧にIssues,期限付きテーブルとResults,記録テーブルを設定する
分類B(ClassB) サイトID(自動で入る)。選択肢一覧は設定しない
状況(Status) 選択肢に 100(申請中)と 300(承認)を用意する

3:「テーブル作成申請」テーブルにプロセス「承認」を作成します。

3-1:現在の状況: 申請中(100)
 3-2:変更後の状況: 承認(300)
 3-3:アクション種別: 保存
 3-4:アクセス制御: 承認者のグループを指定

4:承認者に、手順 1 のフォルダのサイトの管理権限を付けます。サーバスクリプトでは、操作したユーザにアクセス権の無い操作は行えず、サイトの作成には「サイトの管理権限」が必要です。

5:「テーブル作成申請」テーブルにスクリプトを登録します。

5-1:「テーブルの管理 > サーバスクリプト」タブで「新規作成」を選択する。
 5-2:タイトル: 任意の名前(例:createRequestedTable)
 5-3:スクリプト: 下記サンプルコードを貼り付け、【作成先フォルダのサイトID】を手順 1 のサイトIDに書き換える
 5-4:条件: 「更新後」にチェック

JavaScript

条件:更新後

// テーブルを作る先のフォルダのサイトID
const PARENT_FOLDER_ID = 【作成先フォルダのサイトID】;
// 「承認」の状況の値
const APPROVED_STATUS = 300;
// 作れる種類(items.NewSite のパラメータ。分類Aの選択肢の保存する値)
const TABLE_TYPES = ['Issues', 'Results'];

// 承認済みでサイトIDが空の申請から、テーブルを作り、作ったサイトIDを分類Bに書き戻す
function createRequestedTable() {
    // UpdateOnExit による再度の更新では動かさない
    if (context.ServerScript.ScriptDepth !== 0) {
        return;
    }
    // 承認済みでない申請、作成済み(サイトIDあり)の申請では何もしない
    if (Number(model.Status) !== APPROVED_STATUS || model.ClassB) {
        return;
    }
    const type = model.ClassA;  // 種類(Issues / Results)
    if (!TABLE_TYPES.includes(type) || !model.Title) {
        context.AddMessage('種類またはテーブル名が空のため、テーブルを作成していません。', 'alert-warning');
        return;
    }
    // 作成先がフォルダ(種類が Sites)であることを確かめる
    const parents = Array.from(items.GetSite(PARENT_FOLDER_ID));
    if (parents.length === 0 || parents[0].ReferenceType !== 'Sites') {
        context.AddMessage('作成先のフォルダを取得できないため、テーブルを作成していません。作成先フォルダのサイトIDを確かめてください。', 'alert-error');
        return;
    }
    const site = items.NewSite(type);
    site.Title = model.Title;
    site.SiteSettings = $ps.JSON.stringify({});
    // 作成できたら、作ったテーブルのサイトIDが site に入る
    if (items.Create(PARENT_FOLDER_ID, site) && site.SiteId) {
        model.ClassB = String(site.SiteId);  // サイトID
        model.UpdateOnExit = true;
        context.AddMessage(`テーブル「${model.Title}」(サイトID:${site.SiteId})を作成しました。`, 'alert-success');
    } else {
        // サイトIDは空のまま残るので、確かめてから保存し直すと作り直せる
        context.AddMessage('テーブルを作成できませんでした。作成先フォルダのサイトIDと、承認者の権限を確かめてから、この申請を保存し直してください。', 'alert-error');
    }
}

createRequestedTable();

注記

  • 状況が承認で、分類B(サイトID)が空の申請を保存したときに作ります。サイトIDが入っている申請を保存し直しても、テーブルは増えません。
  • 種類またはタイトルが空のとき、作成先のフォルダを取得できないとき、テーブルを作れなかったときは、分類B(サイトID)を空のまま残し、context.AddMessageでメッセージを追加します。承認の保存は止めません。作成先フォルダのサイトIDや権限を直してから申請を保存し直すと、もう一度作成を試みます。
  • 作ったテーブルの項目・一覧・アクセス権は設定していません(SiteSettingsは空)。作成後に管理者が設定してください。

関連情報