変数

Zoho People 拡張機能における変数の詳細概要

1. Read/Write:この権限では、変数はユーザーの組織内で表示され、値を閲覧および更新できます。ただし、開発者コンソールで値を変更しても、その更新内容はアップグレードによって反映されず、ユーザーの組織には適用されません。そのような変更は新規サインアップにのみ適用されます。今後の拡張機能アップグレード時には、値以外の変数の詳細のみ更新できます。
   
   
2. 表示専用:表示専用変数はユーザーの組織内で表示されますが、更新はできません。また、その値は開発者コンソールからのアップグレードによっても変更されません。ただし、変数の値を除くその他のデータは、拡張機能の次バージョンへのアップグレード時に更新できます。
   
   
3. 非表示:非表示変数は開発者コンソール上では開発者が管理できますが、ユーザーの組織内のエンドユーザーには表示されません。開発者コンソールで行った変数値の変更は、ユーザーのアカウントにはアップグレードで反映されません。ただし、新規サインアップには反映され、変数の値を除くその他のデータは、拡張機能の次バージョンへのアップグレード時に更新できます。
   
   
4. System:System 変数は開発者コンソール上で開発者が管理できますが、ユーザーの組織内のエンドユーザーには表示されません。この権限タイプでは、ユーザーの組織内で変数の値を変更することはできません。開発者コンソールで行った変数値の変更は、アップグレード時にユーザーのアカウントへ反映されます。
   

1. ユーザーの組織では、SYSTEM 権限の変数を除き、すべてのカテゴリの変数値を API 経由で更新できます。
   
2. 非表示および SYSTEM 権限の変数は、他のコンポーネントで差し込み項目として使用できません。
3. SYSTEM 権限の変数を除き、他のすべての権限の変数には、独自の「変更時スクリプト」関数を設定できます。
   

変数を使用できるコンテキスト

1. カスタム関数 - コードロジックや計算内で値を動的に参照します。
2. メールテンプレート - 事前定義された変数値を使用してメッセージをパーソナライズします。
3. データテンプレート - データの作成や表示時に、値を動的に差し込みます。
4. メールマージテンプレート - ドキュメント生成時に変数を使用し、シームレスにデータを差し込みます。
5. API 連携 - 外部システムや連携用に、API を通じて変数値へアクセスします。
6. 変更時スクリプト関数 - 変数ごとに個別のカスタム関数を設定できます。変数の値が更新されると、その変数に紐づく変更時スクリプト関数が実行されます。

変数プロパティのパッケージング

変更時スクリプト関数

Zoho People 拡張機能の Developer Console では、開発者は変更時スクリプトを定義し、ユーザーの組織でグローバル変数の値が更新されたタイミングで実行されるロジックを処理できます。

動作方法

スクリプトの設定

1. 対象の変数設定画面で、項目値 - 変更時タブに移動します。
2. スクリプトを作成をクリックします。
3. エディタ内で variableMap オブジェクトを使用し、変更前と現在の値にアクセスします。

サンプル構文

1. oldValue - 変更前の変数の値。
2. newValue - 更新後の値。
   

これらの値を使用して、独自のロジックを作成できます。

例:

if (oldVal != newVal)

{

// ここにカスタムロジックを記述

info 'Variable updated from ' + oldVal + ' to ' + newVal;

}

1. 設定済みの変数が更新されたときに、依存項目を再計算する。
2. 重要な設定が変更されたときに、ユーザーや管理者に通知する。
3. しきい値が更新されたときに、値やワークフローをリセットする。
4. グローバル設定に依存する API 通信や連携を更新する。

インストール設定

1. ユーザーが拡張機能をインストールし、その拡張機能に変数が含まれている場合、インストールページに認証変数タブが表示されます。
   
   
   
   
2. このタブには、Read/Write と Read-Only の権限タイプを持つ変数が表示されます。Read-Only 変数は編集できませんが、ユーザーはインストールページ上で Read/Write 変数を直接設定できます。
3. ユーザーがインストール時にこの手順をスキップした場合でも、後から拡張機能の設定スライダー、または開発者向け情報内の Variables タブから変数の値を編集できます。
   

変更内容と影響

新規変数の追加

1. アップグレードを通じて新しいグローバル変数を追加しても、ユーザーの組織内の既存設定に干渉することはありません。
2. その変数は、新しいワークフロー、スクリプト、または項目設定で利用可能になります。
3. 既存の機能やユーザー定義プロセスは、これまでどおり動作し続けます。
4. 現在のセットアップに遡及的な影響を与えない、純粋な追加として扱うことができます。
   

既存変数の更新

1. 変数の説明や名前を更新しても、既存の参照や機能には影響しません。
2. これらは見た目や情報面のみの変更です。
   

1. 非表示／システム変数は、設定画面に表示されなくなる場合があります。
   
2. エンドユーザーは値を編集できなくなる可能性があります。
   

1. 変更前の値に依存しているスクリプト、ワークフロー、またはプロセスは、動作が変わる可能性があります。
2. 開発者は、変更スクリプトを使用して、これらの移行をプログラム的に処理できます。
3. ただし、エンドユーザーは新しい値に合わせて自分のカスタムロジックを手動で更新する必要があります。
   

わずかな値の変更でも、その値に依存するしきい値、条件、計算に影響を与える可能性があります。

変数の削除

変数の削除は破壊的な変更です。ユーザーのデータや設定に長期的な影響を与える可能性があります。実行する前に結果を十分に検討し、本当に必要な場合にのみ進めてください。

1. 削除された変数を参照しているプロセス、項目、スクリプト、またはワークフローはすべて動作しなくなります。
2. これにより、拡張機能全体で実行時エラー、値の欠落、ロジックの失敗が発生する可能性があります。
3. 明示的に実装しない限り、自動的なフォールバックや代替はありません。
   

変数を削除すると、稼働中のユーザー環境を混乱させる可能性があります。廃止予定で未使用、かつ下流の依存関係がない変数のみを削除し、可能であれば明確なリリースノートを伴うメジャーバージョンアップグレード時に実施してください。