ページスクリプトと変数

ページスクリプトと変数

お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。

1. このページの内容

ページスクリプトとは何か、その作成方法、およびページコンポーネント内での利用方法について説明します。ページスクリプトを使用してページ要素に動的な値を設定することで、ページ内で複数のスニペットを用意する必要を最小限に抑えられます。

2. 提供状況

  1. ページスクリプトは、すべてのデータセンターで利用できます。
  2. Creator のすべての料金プランで作成できます。
  3. ページスクリプトを作成できるのはスーパー管理者、管理者、および開発者のみです。他のユーザーは、適切な権限が付与されている場合に限り、有効な方法で閲覧できます。

3. 概要

一般的に、コードスクリプトとは、特定のリクエストを処理するために作成されたコードブロックまたは関数を指します。言い換えると、スクリプトは特定のイベントや条件が発生したときに、設定された処理を実行したり、必要な応答を返したりします。たとえば、ボタンのクリックやキーの押下といったユーザー操作にスクリプトを関連付けるように設定できます。これらのスクリプトにより、特定の処理が発生した際の望ましい出力を定義でき、さまざまな状況でスクリプトの処理フローや応答を開発者が制御できるようになります。

4. Creator におけるページスクリプトとページ変数

Creator では、ページスクリプトはページ内で共通のタスクを実行するために作成できる関数です。これらの関数を使用すると、Delugeスクリプト言語で独自のロジックを記述し、ページ変数を使ってページ内のすべてのページ要素に必要な値を動的に取得・反映できます。

ページスクリプトを使用すると、ページ用のスクリプト全体を 1 か所（[Page Variables & Script]タブ）で管理できます。ページを実行時に開くと、スクリプトが実行され、設定した要素に値が反映されます。
メモ: Creator アプリケーションの 1 つのページにつき、作成できるスクリプトは 1 つだけです。
ページ変数は、スクリプト内で値を保持するために使用します。これらの変数にはデータ型があり、数値、文字列、ブール値など、保持できるデータの種類が決まっています。ページ変数を使用することで、データの保存、計算の実行、スクリプトの実行フローの制御が可能になります。
ページ変数は、まず[Variables]タブで作成する必要があります。つまり、スクリプトの記述中に新しく変数を作成することはできません。
これらの変数には名前を割り当てることができ、その名前をスクリプト内やページ要素内で変数参照として使用できます。
  1. 複雑な関数内でも理解しやすいように、意味が明確で内容を表した変数名を指定することを推奨します。
  2. ページ変数の名前に予約語を使用した場合は、警告が表示されます。
ページ変数への値の代入は、Deluge コードエディターで行います。現在、ページ変数でサポートされているデータ型は、string、int、boolean、float、コレクションです。

Creator では、次のようなコレクション変数をサポートしています。listとmapです。list変数は値の一覧を保存します。例: list_var = ['john', 'smith', 'emma']。リスト内の値にはインデックスを使用してアクセスできます。この例では、'john' は list_var[0] のように参照できます。ここで 0 はインデックスです。同様に、'smith' は list_var[1] のように参照でき、以下同様に続きます。
一方、map変数はキーと値のペア形式で値を保存します。例: map_var = {'名前':'stevin','gender':'male','年齢':'30'}。map 内の値にはキーを使用してアクセスします。この例では、gender の値は map_var('gender') のようにキーを指定して取得できます。ここで 'gender' がキーで、その値が 'male' です。
‌メモ: 整数型および float 型の変数には、表示形式を適用できます。
設定したページスクリプトが期待どおりに動作しているかどうかは、ページスクリプトを実行して確認できます。ページ変数には、実行用ポップアップでテスト値を入力するか、ページスクリプト内で値を代入してから実行できます。これにより、スクリプト内のエラーを特定し、修正することができます。

5. 動作イメージ

たとえば、従業員管理Creator アプリケーションを作成し、その中に従業員ダッシュボードというページを用意しているとします。従業員がそれぞれのダッシュボードにログインすると、このページには、利用可能な病欠・私用休暇の日数を含む従業員の詳細が一覧表示されます。管理者（admin/super admin）は、従業員がログインしたタイミングでこれらの値を動的に反映するページスクリプトを設定できます。以下の動画では、従業員のログインメールアドレスに基づいて、必要な詳細が自動入力される様子を確認できます。


6. 構文

6。1 一般的な構文

メモ: この構文は、次のページ要素に適用されます。パネル、チャート、ゲージ、検索（条件）、埋め込みフォームおよびレポート（項目値）、ボタン（クエリパラメーター）、埋め込みスニペット。詳細はこちら
  1. ${variable_name}
ここで、variable_nameは、ページ変数に割り当てた名前を指します。

コレクション変数は、その種類に応じて、インデックスまたはキーを指定して取得します。コレクション変数の構文は次のとおりです。

  1. ${collectionVar。取得する(0)}
ここで 0 はインデックスを表します。

  1. ${collectionVar。取得する('名前')}

ここで「名前」はキーを表します。

6。2 ZML スニペット

定義済みのページ変数をZML スニペット内で使用する場合の構文は次のとおりです。
  1. <text 種類='variable' 値='${variable_name}'> </text>

6。3 HTML スニペット

定義済みのページ変数をHTML スニペット内で使用する場合の構文は次のとおりです。
  1. <html tag><%=input。variable_name%></html tag>

6。4 クエリパラメーター

変数の値をエンコードしたうえで、コレクション変数をクエリパラメーターとして別のページに渡すことができます。

 
mapコレクション変数の場合、クエリパラメーターは次のように渡します。
collectionVar = {'名前':'stevin', 'gender':'male'}
クエリパラメーター: ?collectionVar=%7B%22name%22:%22stevin%22,%20%22gender%22:%22male%22%7D

listコレクション変数の場合、クエリパラメーターは次のように渡します。

collectionVar = ['john','smith']
クエリパラメーター: ?collectionVar=%5B%22john%22,%22smith%22%5D

    7. ページ変数の使用

    変数を使用できるページ要素は次のとおりです。
    1. パネル:

      1. 表示: パネル内のテキストとボタンの表示内容を、ページ変数の代わりに必要なデータが表示されるよう設定できます。
      2. 操作: パネル内のテキスト、画像、ボタンの操作を、ページ変数の代わりに必要なデータが表示されるよう設定できます。
      3. 画像: パネル内の画像を、ページ変数の代わりに必要なデータが表示されるよう設定できます。
    2. チャート: ページ変数に基づいてデータをフィルターするために、フィルター（条件）を設定するか、ZML 属性を使用できます。
    3. ゲージ: ページ変数に基づいてデータをフィルターするために、フィルター（条件）を設定するか、ZML 属性を使用できます。
    4. 検索: 検索要素を設定して、ページ変数に基づいて検索結果（ページまたはレポート）を表示できます。
    5. フォーム: ページ変数に基づいてデータを表示するように、フォーム内の項目の値を設定できます。
    6. レポート: 変数に基づいてデータをフィルターするために、フィルター（条件）を設定するか、ZML 属性を使用できます。
    7. スニペット: 変数の値に基づいて、HTML および ZML スニペット内にデータを表示できます。
    8. ボタン:
      1. 表示: パネル内のボタンの表示内容を、必要なデータが表示されるように設定できます。方法を参照
      2. 操作: パネル内のボタンの操作を、必要なデータが表示されるように設定できます。方法を参照
      3. 画像: パネル内の画像を、必要なデータが表示されるように設定できます。方法を参照

    8. 利用ケース

    1. 2 つの異なるフォームからデータを表示する - Creator を使用して営業管理アプリケーションを作成したとします。従業員ダッシュボードページで、従業員ごとの獲得商談の合計件数と、チャットおよび通話経由で獲得した商談の件数を表示したいとします。ページ変数内に、各フォームから必要なデータの値を保存するスクリプトを作成することで、パネル要素内でそれらの変数の代わりに必要な値を表示できます。

    2. ボタンクリック時にデータを自動入力して表示する - ‌ホテル管理アプリケーションを作成したとします。ゲストダッシュボードページに、ワンクリックでチェックインとチェックアウトを行えるボタンを配置しているとします。ボタンをクリックしてチェックインフォームが開いたときに、予約 ID、名前、メールアドレスなどのゲストの詳細があらかじめ入力されているようにしたい場合、ボタン操作を設定し、クエリパラメーターに変数名を指定できます。部屋を予約したゲストがページ内のCheck-Inボタンをクリックすると、チェックインフォームにリダイレクトされ、設定どおりに自動入力されたデータを確認できます。
    3. 条件を使用した動的検索 - ‌パートナー向けイベント管理アプリケーションを作成したとします。ダッシュボードページに、パートナーが処理を検索できる検索要素を追加しているとします。各パートナーが、自身の国／所在地で開催される処理のみを検索できるようにしたい場合、パートナーの国に基づいて処理を検索する検索条件を設定し、目的の結果を表示できます。ここで指定する条件は、各国で開催される処理の詳細を保存しているページ変数です。パートナーの国に基づいて処理を取得・表示するスクリプトを作成することで、パートナーは自分の所在地に関連するイベントの詳細に簡単にアクセスできるようになります。

    9. ページスクリプト作成のナビゲーションガイド

    アプリケーションの編集モードで、左上のアプリケーション名をクリックすると、そのアプリケーションで作成された各コンポーネントが表示されます。そこで、対象のページを選択し、ページビルダーを開くボタンをクリックします。画面上部にある アイコンをクリックすると、Page VariablesタブとScriptタブの両方が表示されます。


    10. 前提条件

    ページスクリプトを作成するには、まず変数を作成する必要があります。これらの変数は、その後スクリプト内で使用できます。

    11. 注意事項

    1. 1 ページあたり最大 50 個の変数を作成できます。
    メモ: 以前にページパラメーターを作成している場合、それらも上記の 50 個の変数の上限に含まれます。たとえば、すでに 60 個のパラメーターを作成しているとします。これらはPage Variablesタブに一覧表示され、従来の設定どおりに動作し続けます。ただし、新しいページ変数を作成することはできません。新しいページ変数を作成するには、既存のパラメーターを削除する必要があります。
    1. 変数名は最大 50 文字まで指定できます。
    2. ページ変数名は大文字と小文字が区別されます。
    3. 変数名には、文字（日本語を含む）、数字、アンダースコア（_）を使用できます。
    4. 変数名はアルファベットで開始する必要があります。
    5. データ ID と日付の値をページ変数の値として渡すことができます。

    12. 制限事項

    1. 現在、Creator アプリケーションでは 1 ページあたり 1 つのスクリプト（関数）のみ作成できます。
    2. Creator アプリケーション内で、ページをまたいでスクリプトを呼び出すことはできません。
    3. 以前にページパラメーターを作成している場合、それらを編集することはできません（設定どおりに動作し続けます）。ただし、そのようなパラメーターを削除することはできます。
    4. ページスクリプトでは、データの追加や更新などの書き込み操作は実行できません。
    5. ページスクリプトの設定時には、次の Deluge タスクは一覧に表示されません。
      1. データアクセス
        1. データを追加
        2. データを更新
        3. データを削除
      2. Web データ
        1. postUrl
        2. openUrl
      3. その他
        1. メールを送信
      4. 共有権限
        1. アプリユーザーに権限を割り当てる
    6. カスタム Deluge 関数をページスクリプト内で作成することはできません。
    1. ページスクリプトを設定する
    2. ページについて