PlatformRuntime API
OutSystems PlatformRuntime APIは、以下を行うためのアクションを提供します。
- 実行時にデータベース接続を切り替える。
- 現在のリクエストを一意に識別するGUIDを取得する。
このAPIを使用するには、PlatformRuntime_APIモジュールでアプリケーションに依存関係を追加します。
概要
| アクション | 説明 |
|---|---|
| Audit_CreateAuditLog | セキュアな監査ストレージ内に監査ログレコードを作成します。このアクションは監査ログが正常に保存されるまで待機し、それ以外の場合は例外が発生します。 現在の環境でセキュアな監査ストレージがサポートされていない場合や構成されていない場合、監査ログレコードの作成はスキップされます。 |
| Database_WriteInParallelTransaction | リクエストのメイントランザクションではない他のトランザクションを使用して、オブジェクトに変換されたレコードを書き込みます。 |
| DatabaseConnection_SetConnectionStringForSession | データベース接続のデータベースを実行時および現在のセッション中に切り替えます。 このアクションを使用する場合、いくつかの条件に注意する必要があります。 - 接続文字列が接続するデータベースは、Service Centerのデータベース接続で構成されているものと同じタイプ（Oracle、SQL Server、MySQLなど）である必要があります。 - 従来のWebアプリでは、このアクションを実行する前に前のデータベースとのデータベース接続を使用するAggregateやSQLを実行している場合、新しいデータベースへの切り替えは次のリクエストのときに初めて有効になります。 - モバイルアプリとリアクティブWebアプリでは、AggregateやSQLを実行してレコードを取得する前に、データアクションの最初にこのアクションを実行する必要があります。サーバーリクエスト間でセッションは持続しないため、データベース接続文字列の切り替えが必要なサーバーリクエストごとにこれを実行する必要があります。 - ライセンスにプラットフォーム拡張API機能が含まれている必要があります。 |
| Request_GetKey | 現在のリクエストを一意に識別するRequestKeyを提供します。 現在のコンテキストで利用できるRequestKeyがない場合は、空の文字列が返されます。 |
| Session_GetMobileAppLoginId | モバイルアプリケーションの認証済みセッションを一意に識別するトークンを取得します。 このメソッドは、ユーザー認証済みセッションを一意に識別する必要があるサーバー側セッションストアを管理するときに使用できます。 |
| Session_GetMobileAppLoginInfo | モバイルアプリケーションの認証済みユーザーのユーザー情報を取得します。 このメソッドは、モバイルアプリケーションにレスポンシブな画面を組み込む必要がある相互運用シナリオ向けに設計されています。 |
| Session_GetWebAppLoginInfo | Webアプリケーションの認証済みユーザーのユーザー情報を取得します。 このメソッドは、RESTメソッドのようなセッションのないエンドポイントでセッション情報にアクセスする必要がある相互運用シナリオ向けに設計されています。 |
アクション
Audit_CreateAuditLog
セキュアな監査ストレージ内に監査ログレコードを作成します。このアクションは監査ログが正常に保存されるまで待機し、それ以外の場合は例外が発生します。
現在の環境でセキュアな監査ストレージがサポートされていない場合や構成されていない場合、監査ログレコードの作成はスキップされます。
入力
- Operation
- 型: Text。必須。
ログに記録される操作の名前。 - メッセージ
- 型: Text。必須。
監査ログのメッセージ。 - Extra
- 型: Text。
監査ログに関連する追加情報が含まれるJSON形式の文字列。
Database_WriteInParallelTransaction
リクエストのメイントランザクションではない他のトランザクションを使用して、オブジェクトに変換されたレコードを書き込みます。
入力
- Record
- 型: Object。必須。
並行トランザクションを使用して書き込むレコード。
DatabaseConnection_SetConnectionStringForSession
データベース接続のデータベースを実行時および現在のセッション中に切り替えます。
このアクションを使用する場合、いくつかの条件に注意する必要があります。
- 接続文字列が接続するデータベースは、Service Centerのデータベース接続で構成されているものと同じタイプ（Oracle、SQL Server、MySQLなど）である必要があります。
- 従来のWebアプリでは、このアクションを実行する前に前のデータベースとのデータベース接続を使用するAggregateやSQLを実行している場合、新しいデータベースへの切り替えは次のリクエストのときに初めて有効になります。
- モバイルアプリとリアクティブWebアプリでは、AggregateやSQLを実行してレコードを取得する前に、データアクションの最初にこのアクションを実行する必要があります。サーバーリクエスト間でセッションは持続しないため、データベース接続文字列の切り替えが必要なサーバーリクエストごとにこれを実行する必要があります。
- ライセンスにプラットフォーム拡張API機能が含まれている必要があります。
入力
- connectionName
- 型: Text。必須。
Service Centerで定義されたデータベース接続の名前。 - connectionString
- 型: Text。必須。
データベース接続が新しいデータベースに接続するために使用する接続文字列。 - databaseIdentifier
- 型: Text。
使用する初期データベース（Oracleデータベースでのみ有効。最初に使用されるスキーマを示します）。
Request_GetKey
現在のリクエストを一意に識別するRequestKeyを提供します。
現在のコンテキストで利用できるRequestKeyがない場合は、空の文字列が返されます。
出力
- RequestKey
- 型: Text。
Session_GetMobileAppLoginId
モバイルアプリケーションの認証済みセッションを一意に識別するトークンを取得します。
このメソッドは、ユーザー認証済みセッションを一意に識別する必要があるサーバー側セッションストアを管理するときに使用できます。
出力
- loginId
- 型: Text。
セッション識別子を返します。または、ユーザーがログインしていない場合はNullTextIdentifier()を返します。
Session_GetMobileAppLoginInfo
モバイルアプリケーションの認証済みユーザーのユーザー情報を取得します。
このメソッドは、モバイルアプリケーションにレスポンシブな画面を組み込む必要がある相互運用シナリオ向けに設計されています。
出力
- userId
- 型: Integer。
ユーザー識別子を返します。または、ユーザーがログインしていない場合はNullIdentifier()（userId = 0）を返します。 - isPersistent
- 型: Boolean。
ログインが永続的である場合はTrueになります。
Session_GetWebAppLoginInfo
Webアプリケーションの認証済みユーザーのユーザー情報を取得します。
このメソッドは、RESTメソッドのようなセッションのないエンドポイントでセッション情報にアクセスする必要がある相互運用シナリオ向けに設計されています。
出力
- userId
- 型: Integer。
ユーザー識別子を返します。または、ユーザーがログインしていない場合はNullIdentifier()（userId = 0）を返します。