システムアクション

Last updated
Save as PDF

OutSystemsには、アプリケーションのビジネスルールを定義するアクションを設計する場合に使用できる複数のシステムアクションが用意されています。

システムアクションの実行方法はモジュールの他のアクションと同じです。システムアクションは、［Logic］タブのServer Actionsフォルダ内のSystemモジュールにあります。

モバイルアプリを開発する場合は、サーバー側で利用できるシステムアクションとともに、クライアント側で実行されるシステムアクションも複数用意されています。これらのクライアントアクションは、Client Actionsフォルダ内のSystemモジュールにあります。

デフォルトでは、システムアクションのサブセットのみがモジュールに追加されます。Systemモジュールから新しい依存関係を追加することで、いつでもその他のシステムアクションを追加できます。

モジュールで設計するアクションと同様に、一部のシステムアクションは関数として定義され、式で使用することもできます。これらは、［Expression］エディタの［Scope］ツリーにあるUser Functionsフォルダにあります。

概要

サーバーアクション	説明	関数かどうか
AbortTransaction	データベースのROLLBACKコマンドを発行し、最後のコミット以降にデータベースで実行されたすべての変更を元に戻します。
ActivityClose	Human ActivityまたはWaitアクティビティを明示的に閉じ、実行を終了します。次の順番のHuman ActivityのIDが特定された場合、それが返されます。
ActivityGetUrl	アクティビティが実行されるWeb画面が開かれたとき、そのURLを返します。	Yes
ActivityOpen	エンドユーザーのタスクボックスでHuman Activityインスタンスを開くように明示的に強制します。
ActivityReset	Human Activityをリリースし、別のエンドユーザーが開いて実行できるようにします。
ActivitySchedule	Human Activityがタスクボックスで利用可能になる日付をスケジュール設定します。
ActivitySetGroup	特定のグループに属するエンドユーザーにHuman Activityの表示と処理を制限します。
ActivitySkip	Human ActivityまたはWaitアクティビティの実行を明示的にスキップします。次の順番のHuman ActivityのIDが特定された場合、それが返されます。
ActivityStart	ConditionalStartアクティビティの実行を明示的に開始します。
ClientCertificateGetDetails	現在のリクエストのクライアント証明書の関連情報を.NETフレームワークから取得します。
ClientCertificateValue	.NETフレームワークのクライアント証明書の特定のプロパティの値を取得します。
CommitTransaction	データベースのCOMMITコマンドを発行し、最後のコミット以降にデータベースで実行されたすべての変更を有効にします。
EspaceInvalidateCache	eSpaceの特定のキャッシュをすべてのフロントエンドサーバーとコンシューマeSpaceで無効にします。テナント識別子を設定すると、無効化を単一のテナントに限定します。
GenerateGuid	新しいGUIDを生成して返します。	Yes
InboundSmsGetDetails	現在処理されている受信SMSに関する情報を返します。
IntegratedSecurityCheckRole	現在のWindowsユーザーが、特定のロールにアクセスできるかどうかを検証します。	Yes
IntegratedSecurityGetDetails	リクエストを行った現在のWindowsユーザーに関する情報を取得します。
ListAll	リスト内のすべての要素が指定された条件を満たしているかどうかを判定します。
ListAny	リスト内の任意の要素が指定された条件を満たしているかどうかを判定します。
ListAppend	リストの末尾に要素を追加します。
ListAppendAll	元のリストの要素を追加先のリストの末尾に追加します。
ListClear	リストからすべての要素を削除します。
ListDuplicate	リストの要素を別のリストに複製します。	Yes
ListFilter	指定された条件を満たしたListパラメータの要素の新しいリストを返します。
ListIndexOf	指定された条件を満たしたListパラメータの最初の要素の位置を返します。条件を満たす要素が検出されなかった場合は-1を返します。
ListInsert	リストの特定の位置に要素を挿入します。
ListRemove	リストの特定の位置から要素を削除します。
ListSort	指定された基準でListパラメータの要素を並べ替えます。ListSortはAggregateの動的ソートとは異なります。異なるデータ型（TextやIntegerなど）の基準がある複数のアトリビュートは、リストを正確に並べ替えられない場合があります。
Login	指定されたユーザーでアプリケーションにログインします。成功の場合、UserIdセッション変数とUsernameセッション変数にユーザーデータが入力されます。
LoginPassword	パスワードを使用して、指定されたユーザーでアプリケーションにログインします。成功の場合、UserIdセッション変数とUsernameセッション変数にユーザーデータが入力されます。
LogMessage	Service Centerのモジュールの一般ログに表示できる情報を登録します。
Logout	特定のユーザーをアプリケーションからログアウトします。 'UserIdセッション変数とUsernameセッション変数はクリアされます。
Notify	Webブロックが、それを使用する画面またはWebブロックに通知する方法。通知はOn Notifyプロパティで設定されたアクションによって処理されます。通知によって送信されるメッセージを取得するには、NotifyGetMessage関数を使用します。
NotifyGetMessage	Notifyアクションによって送信された通知メッセージを返します。	Yes
NotifyWidget_Deprecated	Webブロックが、それを使用する画面またはWebブロックに通知する方法。通知はOn Notifyプロパティで設定されたアクションによって処理されます。通知によって送信されるメッセージを取得するには、NotifyGetMessage関数を使用します。
ProcessTerminate	プロセスの実行をターミネートするように明示的に強制します。
SetCurrentLocale	ユーザーセッションの言語ロケールを設定し、アプリケーションの表示言語を変更します。
TenantCreate	新しいテナントを作成してプロビジョニングサイトに関連付けます。
TenantInvalidateCache	テナントの特定のキャッシュをすべてのフロントエンドサーバーとeSpaceで無効にします。このアクションは互換性のみを目的として使用できるようになりました。EspaceInvalidateCacheアクションを代わりに使用し、eSpaceでテナントの特定のキャッシュを無効にして、無効化のスコープを狭めてください。
TenantSwitch	指定されたテナント識別子に対するコンテキストを変更します。テナントを切り替えるとき、セッションがクリアされ（テナント変更前の暗黙的なログアウトと同等）、OnSessionStartアクションが実行され、現在のトランザクションがコミットされます。

クライアントアクション	説明	関数かどうか
ListAll	リスト内のすべての要素が指定された条件を満たしているかどうかを判定します。
ListAny	リスト内の任意の要素が指定された条件を満たしているかどうかを判定します。
ListAppend	リストの末尾に要素を追加します。
ListAppendAll	元のリストの要素を追加先のリストの末尾に追加します。
ListClear	リストからすべての要素を削除します。
ListDuplicate	リストの要素を別のリストに複製します。	Yes
ListFilter	指定された条件を満たしたListパラメータの要素の新しいリストを返します。
ListIndexOf	指定されたの条件を満たしたListパラメータの最初の要素の位置を返します。条件を満たす要素が検出されなかった場合は-1を返します。
ListInsert	リストの特定の位置に要素を挿入します。
ListRemove	リストの特定の位置から要素を削除します。
ListSort	指定された基準でListパラメータの要素を並べ替えます。ListSortはAggregateの動的ソートとは異なります。異なるデータ型（TextやIntegerなど）の基準がある複数のアトリビュートは、リストを正確に並べ替えられない場合があります。
LogMessage	Service Centerのモジュールの一般ログに表示できる情報を登録します。
RequireScript	HTMLヘッダーにJavaScriptを追加します。同じJavaScriptを複数回呼び出しても、追加されるのは1回のみです。JavaScriptが正常に読み込まれた後、アクションフローの処理が進みます。
ScreenReachedFromHistory	現在の画面に履歴から（「戻る」ナビゲーションを使用するなどして）到達したかどうかを判定します。	Yes

サーバーアクション

AbortTransaction

データベースのROLLBACKコマンドを発行し、最後のコミット以降にデータベースで実行されたすべての変更を元に戻します。

ActivityClose

Human ActivityまたはWaitアクティビティを明示的に閉じ、実行を終了します。
次の順番のHuman ActivityのIDが特定された場合、それが返されます。

入力

ActivityId: 型: 必須。Activity Identifier。

出力

NextHumanActivityId: 型: Activity Identifier。

ActivityGetUrl

アクティビティが実行されるWeb画面が開かれたとき、そのURLを返します。

入力

ActivityId: 型: 必須。Activity Identifier。

出力

HandlingUrl: 型: Text。

ActivityOpen

エンドユーザーのタスクボックスでHuman Activityインスタンスを開くように明示的に強制します。

入力

ActivityId: 型: 必須。Activity Identifier。

出力

HandlingUrl: 型: Text。

ActivityReset

Human Activityをリリースし、別のエンドユーザーが開いて実行できるようにします。

入力

ActivityId: 型: 必須。Activity Identifier。
ResetActivityUser: 型: 必須。Boolean。

ActivitySchedule

Human Activityがタスクボックスで利用可能になる日付をスケジュール設定します。

入力

ActivityId: 型: 必須。Activity Identifier。
StartDate: 型: 必須。Date Time。

ActivitySetGroup

特定のグループに属するエンドユーザーにHuman Activityの表示と処理を制限します。

入力

ActivityId: 型: 必須。Activity Identifier。
GroupId: 型: 必須。Group Identifier。

ActivitySkip

Human ActivityまたはWaitアクティビティの実行を明示的にスキップします。
次の順番のHuman ActivityのIDが特定された場合、それが返されます。

入力

ActivityId: 型: 必須。Activity Identifier。

出力

NextHumanActivityId: 型: Activity Identifier。

ActivityStart

ConditionalStartアクティビティの実行を明示的に開始します。

入力

ActivityId: 型: 必須。Activity Identifier。

出力

NextHumanActivityId: 型: Activity Identifier。

ClientCertificateGetDetails

.NET現在のリクエストのクライアント証明書の関連情報をフレームワークから取得します。

出力

cookie: 型: Text。
指定されている場合、クライアント証明書の一意のIDを取得します。
flags: 型: Integer。
追加のクライアント証明書情報を提供するフラグのセット。クライアント証明書が存在する場合、Bit0が1に設定されます。クライアント証明書のCA（認証局）がサーバー上の認識済みCAのリスト内にない場合、Bit1が1に設定されます。
isPresent: 型: Boolean。
クライアント証明書が存在するかどうかを示す値を取得します。
issuer: 型: Text。
証明書の発行者に関する情報を含むサブフィールド値のリストが含まれる文字列。
isValid: 型: Boolean。
クライアント証明書が有効かどうかを示す値を取得します。
serialNumber: 型: Text。
証明書のシリアル番号を、ハイフンで区切られた16進バイトのASCII表現として提供します。たとえば、04-67-F3-02などです。
serverIssuer: 型: Text。
サーバー証明書の発行者フィールドを取得します。
serverSubject: 型: Text。
サーバー証明書の件名フィールドを取得します。
subject: 型: Text。
クライアント証明書の件名フィールドを取得します。
validFrom: 型: Date Time。
証明書が有効になる日付を取得します。日付は国際設定によって異なります。
validUntil: 型: Date Time。
証明書の有効期限の日付を取得します。

ClientCertificateValue

.NETフレームワークのクライアント証明書の特定のプロパティの値を取得します。

入力

key: 型: 必須。Text。

出力

value: 型: Text。

CommitTransaction

データベースのCOMMITコマンドを発行し、最後のコミット以降にデータベースで実行されたすべての変更を有効にします。

EspaceInvalidateCache

eSpaceの特定のキャッシュをすべてのフロントエンドサーバーとコンシューマeSpaceで無効にします。テナント識別子を設定すると、無効化を単一のテナントに限定します。

入力

EspaceId: 型: 任意。Espace Identifier。
無効にするeSpaceの識別子。指定されていない場合は、呼び出し側のeSpaceの識別子が使用されます。
TenantId: 型: 任意。Tenant Identifier。
キャッシュの無効化を特定のテナントに限定するための任意指定のテナント識別子。

GenerateGuid

新しいGUIDを生成して返します。

出力

Guid: 型: Text。

InboundSmsGetDetails

現在処理されている受信SMSに関する情報を返します。

出力

MSISDN: 型: Phone Number.。
LargeAccount: 型: Phone Number.。
メッセージ: 型: Text。
BinaryMessage: 型: Text。
UDH: 型: Text。
MessageId: 型: Text。
Priority: 型: Integer。
Encoding: 型: Text。
Connection: 型: Text。
OperatorCode: 型: Text。
Sent: 型: Date Time。
Custom1: 型: Text。
Custom2: 型: Text。
Custom3: 型: Text。

IntegratedSecurityCheckRole

現在のWindowsユーザーが、特定のロールにアクセスできるかどうかを検証します。

入力

RoleName: 型: 必須。Text。

出力

Belongs: 型: Boolean。

IntegratedSecurityGetDetails

リクエストを行った現在のWindowsユーザーに関する情報を取得します。

出力

Username: 型: Text。
isGuest: 型: Boolean。
isSystem: 型: Boolean。
isAnonymous: 型: Boolean。
isAuthenticated: 型: Boolean。

ListAll

リスト内のすべての要素が指定された条件を満たしているかどうかを判定します。

入力

List: 型: 必須。Generic Record List。
条件を適用する要素が含まれるリスト。
Condition: 型: 必須。Boolean。
リストの各要素を確認するためのBoolean式。

出力

Result: 型: Boolean。
リストのすべての要素が条件を満たしている場合はTrue、それ以外の場合はFalseになります。

ListAny

リスト内の任意の要素が指定された条件を満たしているかどうかを判定します。

入力

List: 型: 必須。Generic Record List。
条件を適用する要素が含まれるリスト。
Condition: 型: 必須。Boolean。
リストの各要素を確認するためのBoolean式。

出力

Result: 型: Boolean。
条件を満たしているリストの要素がある場合はTrue、それ以外の場合はFalseになります。

ListAppend

リストの末尾に要素を追加します。

入力

List: 型: 必須。Generic Record List。
要素を追加するリスト。
Element: 型: 必須。Generic Record。
リストの末尾に追加される要素。

ListAppendAll

元のリストの要素を追加先のリストの末尾に追加します。

入力

List: 型: 必須。Generic Record List。
追加先のリスト。
SourceList: 型: 必須。Generic Record List。
追加する要素のリスト。

ListClear

リストからすべての要素を削除します。

入力

List: 型: 必須。Generic Record List。
要素を削除するリスト。

ListDuplicate

リストの要素を別のリストに複製します。

入力

SourceList: 型: 必須。Generic Record List。
複製するリスト。

出力

DuplicatedList: 型: Generic Record List。
複製されたリスト。

ListFilter

指定された条件を満たしたListパラメータの要素の新しいリストを返します。

入力

SourceList: 型: 必須。Generic Record List。
条件を適用する要素が含まれるリスト。
Condition: 型: 必須。Boolean。
リストの各要素を確認するためのBoolean式。

出力

FilteredList: 型: Generic Record List。
条件を満たす要素の新しいリスト。

ListIndexOf

指定された条件を満たしたListパラメータの最初の要素の位置を返します。条件を満たす要素が検出されなかった場合は-1を返します。

例

ListIndexOf(UserList, Is_Active)

ユーザーレコードリスト内で条件Is_Active = Trueを満たす最初のユーザーの位置を返します。

ListIndexOf(UserList, Name = "James")

ユーザーレコードリスト内で条件Name = "James"を満たす最初のユーザーの位置を返します。

入力

List: 型: 必須。Generic Record List。
条件を適用する要素が含まれるリスト。
Condition: 型: 必須。Boolean。
リストの各要素を確認するためのBoolean式。

出力

Position: 型: Integer。
指定された条件を満たしたリストの最初の要素の位置。条件を満たす要素が検出されなかった場合は-1。

ListInsert

リストの特定の位置に要素を挿入します。

入力

List: 型: 必須。Generic Record List。
要素を追加するリスト。
Element: 型: 必須。Generic Record。
リストに挿入する要素。
Position: 型: 必須。Integer。
要素が挿入される位置。

ListRemove

リストの特定の位置から要素を削除します。

入力

List: 型: 必須。Generic Record List。
要素が削除されるリスト。
Position: 型: 必須。Integer。
削除される要素の位置。

ListSort

指定された基準でListパラメータの要素を並べ替えます。ListSortはAggregateの動的ソートとは異なります。異なるデータ型（TextやIntegerなど）の基準がある複数のアトリビュートは、リストを正確に並べ替えられない場合があります。

例

ListSort(UserList, Name)

UserList（ユーザーレコードのリスト）をNameアトリビュートで並べ替えます。

ListSort(TextList, Value, False)

TextList（テキスト値のリスト）をValueの降順に並べ替えます。 
Valueは、並べ替えられる現在のテキスト値を表すランタイムプロパティです。

ListSort(OfficeEmployeesList, Employee.Name + " " + Office.Name)

OfficeEmployeesList（従業員およびオフィスレコードのリスト）を従業員名およびオフィス名で並べ替えます。従業員が複数のオフィスで働いている場合、この並べ替えられたリストには異なるオフィスの従業員レコードとして含まれ、従業員自身の名前とオフィスの名前の両方の昇順で連続して表示されます。

入力

List: 型: 必須。Any List。
指定された基準で並べ替える要素が含まれるリスト。
By: 型: 必須。Any Data Type。
リストの要素を並べ替える基準。
Ascending: 型: 任意。Boolean。
Byパラメータに従って要素を昇順に並べ替えるか（True）、降順に並べ替えるか（False）を示すBoolean式。デフォルト値は昇順（True）です。

指定されたユーザーでアプリケーションにログインします。
成功の場合、UserIdセッション変数とUsernameセッション変数にユーザーデータが入力されます。

入力

UserId: 型: 必須。User Identifier。
Persistent: 型: 必須。Boolean。
Trueの場合、ログインは15日間保持されます。

LoginPassword

パスワードを使用して、指定されたユーザーでアプリケーションにログインします。
成功の場合、UserIdセッション変数とUsernameセッション変数にユーザーデータが入力されます。

入力

UserId: 型: 必須。User Identifier。
Password: 型: 必須。Text。
Persistent: 型: 必須。Boolean。
Trueの場合、ログインは15日間保持されます。

LogMessage

Service Centerのモジュールの一般ログに表示できる情報を登録します。

入力

メッセージ: 型: 必須。Text。
モジュールの一般ログに追加するメッセージ。
ModuleName: 型: 必須。Text。
ログメッセージに関連付けられるモジュールの名前。

Logout

特定のユーザーをアプリケーションからログアウトします。
UserIdセッション変数とUsernameセッション変数はクリアされます。

Notify

Webブロックが、それを使用する画面またはWebブロックに通知方法。通知はOn Notifyプロパティで設定されたアクションによって処理されます。通知によって送信されるメッセージを取得するには、NotifyGetMessage関数を使用します。

入力

メッセージ: 型: 任意。Text。

NotifyGetMessage

Notifyアクションによって送信された通知メッセージを返します。

出力

メッセージ: 型: Text。

NotifyWidget_Deprecated

入力

メッセージ: 型: 任意。Text。

ProcessTerminate

プロセスの実行をターミネートするように明示的に強制します。

入力

ProcessId: 型: 必須。Process Identifier。

SetCurrentLocale

ユーザーセッションの言語ロケールを設定し、アプリケーションの表示言語を変更します。

入力

ロケール: 型: 必須。Text。

TenantCreate

新しいテナントを作成してプロビジョニングサイトに関連付けます。

入力

eSpaceName: 型: 必須。Text。
TenantName: 型: 必須。Text。

出力

TenantId: 型: Tenant Identifier。

TenantInvalidateCache

テナントの特定のキャッシュをすべてのフロントエンドサーバーとeSpaceで無効にします。このアクションは互換性のみを目的として使用できるようになりました。EspaceInvalidateCacheアクションを代わりに使用し、eSpaceでテナントの特定のキャッシュを無効にして、無効化のスコープを狭めてください。

入力

TenantId: 型: 必須。Tenant Identifier。
特定のキャッシュをすべて無効化するテナントの識別子。

TenantSwitch

指定されたテナント識別子に対するコンテキストを変更します。テナントを切り替えるとき、セッションがクリアされ（テナント変更前の暗黙的なログアウトと同等）、OnSessionStartアクションが実行され、現在のトランザクションがコミットされます。

入力

TenantId: 型: 必須。Tenant Identifier。

クライアントアクション