メインコンテンツまでスキップ

環境情報変数の確認

ここでは、環境情報変数の確認方法について説明します。

注意

環境情報変数はシステムによって自動的に生成・管理されるため、基本的には値を編集せず参照するために使用します。値を変更すると、画面や処理の動作に不具合が生じたり、意図しない情報漏洩やパフォーマンス低下の原因となったりすることがあります。

参考

設定に進む前に、環境情報変数の概要を確認したい場合は、「画面変数と環境情報の設定 > 環境情報変数とは」を参照してください。

環境情報変数を表示する​

環境情報変数にどのような種類があり、どのように分類されているのかを確認します。

  1. ［ ］をクリックして、［環境］を選択します。
  2. 階層を確認したい変数の［ ］をクリックします。
    └ 選択した変数の配下にある変数が展開されます。

環境情報変数の種類​

ユーザ・アカウント情報​

ログイン中のユーザやアカウントに関する情報を保持する変数です。

アカウントコンテキスト（accountContext）は、アカウントに関する情報をまとめて扱うことができる変数です。この変数を使用すると、ログインしているユーザのコードや表示言語（ロケール）、認証の状態などを取得できます。取得できる情報は管理者および一般ユーザが設定した内容に基づくため、各種操作ガイドもあわせて参照することをおすすめします。

変数名型プロパティ名用途
applicationLicenses配列/文字列　　　アプリケーションライセンス一覧　ユーザが利用可能なアプリケーションやユーザごとのライセンス状況を確認
「テナント管理者操作ガイド - アプリケーションライセンス一覧を使用する」
authenticated真偽値認証状況ユーザがログインしているかどうかをtrue/falseで判定
calendarId文字列カレンダーIDユーザが利用しているカレンダーの情報を取得
「一般ユーザ操作ガイド - カレンダーを設定する」
dateTimeFormatsマップ日時表示形式一覧ユーザが設定している日付・時刻データの表示形式を取得（標準的な日付・時刻形式、入力用の日付・時刻形式、タイムスタンプ、ロケールなど）
「一般ユーザ操作ガイド - 日付と時刻の形式を設定する」
decimalFormatId文字列数値形式のフォーマットIDユーザが設定している数値形式を取得し、数値データを指定形式に変換
「一般ユーザ操作ガイド - 数値形式を設定する」
encoding文字列文字エンコーディング文字列がUTF-8であることを参照・確認するための情報
※intra-mart Accel Platformで使用する文字コードはUTF-8 のみ
firstDayOfWeek文字列週の開始曜日ユーザが設定しているカレンダーから週の開始曜日の情報を取得
「一般ユーザ操作ガイド - カレンダーを設定する」
homeUrl文字列ホームURLユーザがアプリに表示するホーム画面の設定
「テナント管理者操作ガイド - ホームURLを設定する」
locale文字列ロケールユーザが設定しているロケール（言語）を取得
「一般ユーザ操作ガイド - ロケールを設定する」
loginTime日付・時刻ログイン時刻ユーザがログインした日付・時刻を取得
roleIds配列/文字列ロールID一覧ユーザに付与されているロールIDを取得
「テナント管理者操作ガイド - ロールを設定する」
signature文字列ログイン署名ユーザが正しくログインしていることを示す識別情報を取得
tenantId文字列テナントIDアクセスしているユーザに応じたテナントIDを取得
「システム管理者操作ガイド - テナント情報」
themeId文字列テーマIDアクセスしているユーザが設定しているテーマIDを取得
「一般ユーザ操作ガイド - テーマを設定する」
「テーマ仕様書 - intra-mart が提供するテーマの一覧」
timeZoneマップタイムゾーンユーザが設定しているタイムゾーンを取得
（協定世界時（UTC）との時差、夏時間の適用有無）
「一般ユーザ操作ガイド - ロケールを設定する」
userCode文字列ユーザコード共通マスタに登録されているユーザコードを取得
「IM-共通マスタ 管理者操作ガイド - ユーザの基本設定」
userType文字列ユーザ種別ユーザの種別を取得
- 一般ユーザ: ログインユーザおよび未認証ユーザ
- システム管理者: システムで利用するユーザ
- プラットフォームユーザ: ジョブの実行ユーザ
参考

アカウントコンテキストの詳細は、「アクセスコンテキスト仕様書 - 4.6.1. アカウントコンテキスト」を参照してください。

実行環境情報​

アプリケーションが動作している環境やユーザの端末に関する情報を保持する変数です。

サーバ情報（serverInfo）は、サーバ名やホスト名、IPアドレスなど、アプリケーションが稼働しているサーバに関する情報をまとめて扱うことができる変数です。この変数を使うと、アプリケーションの実行環境を識別したり、ログ出力や監査用にサーバ情報を参照したりできます。取得できる情報は管理者が設定した内容に基づくため、各種操作ガイドもあわせて参照することをおすすめします。

親変数名型子変数名型プロパティ名用途
systemマップ/配列localesマップ/配列システムロケール情報ユーザに表示する言語名（日本語、英語、中国語）や文字コード（UTF-8）の設定を取得
「システム管理者操作ガイド - ロケールを変更する」
timeZoneマップ/マップシステムタイムゾーン情報サーバに設定されているタイムゾーンを取得
（協定世界時（UTC）との時差、夏時間の適用有無）
「タイムゾーン仕様書」
tenantマップcalenderId文字列テナントカレンダーIDテナントごとのカレンダー設定を取得
「テナント管理者操作ガイド - カレンダー情報を設定する」
firstDayOfWeek整数テナント週の開始曜日テナントに設定されているカレンダーから週の開始曜日の情報を取得
「テナント管理者操作ガイド - カレンダー情報を設定する」
localesマップ/マップテナントロケール情報ユーザに表示する言語名（日本語、英語、中国語）や文字コード（UTF-8）の設定を取得
「システム管理者操作ガイド - テナント情報」
timeZoneマップ/マップテナントタイムゾーン情報テナントに設定されているタイムゾーンを取得
（協定世界時（UTC）との時差、夏時間の適用有無）
「テナント管理者操作ガイド - タイムゾーンを設定する」

画面表示関連​

アプリケーション画面に直接反映される情報を保持する変数です。

装飾情報（modifier）は、コンポーネントや要素の見た目や挙動を調整する変数です。この変数を利用することで、文字色や背景色の指定や、特定の画面サイズでは非表示にするなどレスポンシブ制御に活用できます。

変数名型プロパティ名用途
colorマップ　　文字色intra-mart標準の文字色の種類を取得（16種類の色から選択）
backgroundColorマップ　　背景色intra-mart標準の背景色の種類を取得（16種類の色から選択）
hideマップ　　非表示情報　　　　特定の画面サイズで要素を表示・非表示（モバイル、タブレット、デスクトップ、タッチスクリーン、ワイドスクリーン、フルHDから選択）

文字色と背景色で規定されている色は、以下の16種類です。

  • モノトーンカラー：white、light、dark、black
  • 用途別のカラー：primary、link、info、success、warning、danger
  • 用途別のライトカラー：primary light、link light、info light、success light、warning light、danger light
注意

コンテンツ種別「imui」では、装飾情報（modifier）は表示されません。imuiは、intra-martのガイドラインに沿ったデザインを適用するコンテンツ種別です。詳細は「画面コンテンツの作成 > コンテンツ種別について」を参照してください。

定数・その他​

常に固定の値として利用できる情報を保持する変数です。

定数（const）は、アプリケーション内で固定して扱う値を保持する変数です。この変数を利用することで、開始時刻やブール値、HTTPステータスコードなど、処理中に変更されない値を簡単に参照できます。

変数名型プロパティ名用途
startTime日付・時刻画面表示時の日時画面が表示された日時を取得するために使用
true真偽値ブール値（true）条件判定やフラグ管理など、真を意味する値として使用
false真偽値ブール値（false）条件判定やフラグ管理など、偽を意味する値として使用
null文字列無値値が未設定または存在しないことを表す際に使用
httpStatusCodeマップHTTPステータスコード通信結果のステータス（例：200、404）を取得・判定するために使用

HTTPステータスコードの意味は以下のとおりです。

  • 200 OK：リクエストが正常に処理されたことを示す
  • 400 Bad Request：クライアントのリクエストが不正であることを示す
  • 401 Unauthorized：認証が必要で、認証情報がない、または不正である場合に返される
  • 403 Forbidden：認証は通っているが、アクセス権限がない場合に返される
  • 404 Not Found：指定されたリソース（ページやAPI）が存在しない場合に返される
  • 500 Internal Server Error：サーバ側の問題でリクエストを処理できなかった場合に返される
  • 503 Service Unavailable：サーバが一時的に利用できない場合に返される

画面変数の定数と環境情報変数の定数の違い

画面変数の定数（$constant）と環境情報変数の定数（$env.const）には、以下のような違いがあります。

項目画面変数の定数環境情報変数の定数
定義場所画面上で固定値として設定される変数システムが提供する変数
値の性質開発者が画面で直接設定した固定値実行時に変化するが参照時点では読み取り専用として利用可能
利用用途画面表示の初期値、選択肢、条件判定ユーザID、ログイン状態、言語設定など、画面全体で共通して参照
実行環境依存　　　なし（どの環境でも同じ値）あり（ユーザ、テナント、サーバ環境などに依存）

画面変数の定数は特定の画面で固定値として使われるのに対し、環境情報変数は画面や処理に関係なく参照できる、実行環境に依存する共通の定数という違いがあります。

環境情報変数を一時的に変更する​

環境情報変数はシステムによって自動的に生成・管理されるため、値を直接編集することはできません。ただし、プレビュー画面で一時的に値を変更したり、動作確認や検証用に別の変数に値を代入して利用したりすることが可能です。

プレビュー画面で確認する場合​

(1) 現在の表示を確認する​

テキストボックスの値に環境情報変数$env.accountContext.userCdを設定した画面を例に説明します。accountContext.userCdは、共通マスタに登録されているユーザコードを取得する変数です。

ここではIM-BloomMakerに「aoyagi」でログインしているため、環境情報変数userCdの値としてaoyagiが表示されています。プレビュー画面でもUser Codeにaoyagiが反映されます。

(2) 環境情報変数の値を編集する​

別のユーザでログインした場合の表示を確認するには、プレビュー画面を開いた状態で環境情報変数の値を変更します。$env.accountContext.userCdの［ ］をクリックし、代入値をaoyagiからhayashiに変更して［決定］をクリックします。

変更後は、環境情報変数userCdの値がhayashiとなり、プレビュー画面のUser Codeにもhayashiが表示されます。このように、プレビュー画面上では一時的に値を切り替えて表示を確認できます。

(3) 環境情報変数の値をリセットする​

環境情報変数の値は、ブラウザを再読み込みすると元の状態に戻ります。ここではIM-BloomMakerに「aoyagi」でログインしているため、aoyagiが表示されます。また、仮に変更した値hayashiのまま画面を保存してしまっても、環境情報変数の値は上書きされないため、再度画面を開くと元の値aoyagiが表示されます。

別の変数に代入して利用する場合​

プレビュー画面だけでなく、テストや検証時に値を模擬的に差し替えて動作を確認したい場合は、環境情報変数の値を変数$variableに代入して利用することができます。

(1) テスト用の変数を作成する​

例として、環境情報変数$env.accountContext.userCdの値を格納するために、テスト用の変数$variable.userCodeを作成します。このとき、テスト用の変数は、環境情報変数と同じデータ型・構造で作成してください。

(2) 画面の初期化アクションを設定する​

画面が表示される際に、変数$variable.userCodeに環境情報変数$env.accountContext.userCd値を代入する処理をアクションとして設定します。これにより、テスト用として任意の値に差し替えて動作確認が可能になります。

参考

変数の値の代入は、アクションで設定できます。アクション設定の詳細は「アクション設定」を参照してください。また、変数$variableに環境情報変数$envの値を代入している例について、「IM-BloomMaker チュートリアルガイド - 5.1.4. アクションを設定する」もあわせて参照してください。