ビルトインのユーザーサービス

EBX®には、多数のビルトインユーザーサービスが含まれています。ビルトインのユーザーサービスを使用できます。

• ワークフローモデルタスクを定義する場合

• パースペクティブアクションメニュー項目を定義する場合

• サービス拡張機能とともに使用する場合の拡張ユーザーサービスとして

• EBX®をWebコンポーネントとして使用する場合

 

このリファレンスページでは、ビルトインのユーザーサービスとそのパラメーターについて説明します。

 

データへのアクセス（デフォルトサービス）

デフォルトでは、ワークフローはこのサービスを自動的に完了したと見なします。つまり、[承認] ボタンは常に使用できます。

これは、サービスが指定されていない場合に使用されるデフォルトのサービスです。

入力パラメーター

パラメーター	ラベル	説明
branch	データスペース	指定されたデータスペースの識別子-このサービスにはデータスペースが必要です。
disableAutoComplete	開始時に承認を無効化	デフォルトでは、このサービスに関連付けられた対話は直接完了したと見なされます。したがって、作業項目の開始時に[承認]ボタンが自動的に表示されます。このパラメーターは、この動作を無効にするのに役立ちます。値が「true」の場合、開発者は、たとえば、ユーザーサービスまたはトリガーでSessionInteractionを使用して対話を完了する責任があります。デフォルト値は「false」です。パースペクティブはこのパラメーターを使用しません。
firstCallDisplay	ファーストコール表示モード	最初の呼び出し時にフィルター処理されたテーブルまたはレコードを表示するときに使用する必要がある表示モードを定義します。デフォルト（値= 'auto'）：選択に応じて表示が自動的に設定されます。ビュー（値= 'view'）：表形式のビューまたは階層ビューの表示を強制します。レコード（値 = 'record'）：述部に少なくとも1つのレコードがある場合、レコードフォームの表示を強制します。
instance	データセット	値は、選択したデータスペースに存在するデータセットの参照である必要があります。
scope	範囲	このサービスのユーザーナビゲーションの範囲、つまり、ユーザーがセッション中に選択できるエンティティを定義します。空白のままにすると、デフォルト値が使用されます。パースペクティブの場合、デフォルト値は常に「ノード」です。ワークフローの場合、デフォルト値は選択したエンティティまたはサービスによって異なります。
trackingInfo	追跡情報	追跡情報は「履歴」ログに記録されます。また、アクセス制御や追加のエクスポート情報など、その他の目的にも使用できます。
version	スナップショット	指定されたスナップショットの識別子-このサービスにはデータスペースが必要です。
viewPublication	ビュー	表示するビューの公開名。選択したテーブルに対してビューを構成する必要があります。
xpath	データセットノード（XPath）	値は、選択したデータセット内の有効な絶対位置パスである必要があります。表記は、簡略化された構文で、簡略化されたXPathに準拠している必要があります。

新しいレコードの作成

ワークフローの場合、最初の正常な送信が実行されたとき（レコードが作成されたとき）に、作成サービスは完了したと見なされます。このサービスがすでに完了しているときに呼び出された場合、作成されたレコードは更新モードまたは読み取り専用モードで表示されます（ユーザー権限によって異なります）。

サービス名パラメーター：service=@creation

入力パラメーター

パラメーター	ラベル	説明
branch	データスペース	指定されたデータスペースの識別子-このフィールドは、このサービスに必要です。
instance	データセット	値は、選択したデータスペースに存在するデータセットの参照である必要があります-このフィールドは、このサービスに必要です。
scope	範囲	このサービスのユーザーナビゲーションの範囲、つまり、ユーザーがセッション中に選択できるエンティティを定義します。空白のままにすると、デフォルト値が使用されます。パースペクティブの場合、デフォルト値は常に「ノード」です。ワークフローの場合、デフォルト値は選択したエンティティまたはサービスによって異なります。
trackingInfo	追跡情報	追跡情報は「履歴」ログに記録されます。また、アクセス制御や追加のエクスポート情報など、その他の目的にも使用できます。
xpath	データセットテーブル（XPath）	値は、選択したデータセット内のテーブルの有効な絶対位置パスである必要があります。表記は、簡略化された構文の簡略化されたXPathに準拠している必要があります-このフィールドは、このサービスに必要です。

出力パラメーター

パラメーター	ラベル	説明
created	作成されたレコード	作成されたレコードのXPathが含まれます。

レコードの複製

ワークフローの場合、最初の正常な送信が実行されたとき（レコードが作成されたとき）に、複製サービスは完了したと見なされます。このサービスがすでに完了しているときに呼び出された場合、作成されたレコードは更新モードまたは読み取り専用モードで表示されます（ユーザー権限によって異なります）。

サービス名パラメーター：service=@duplicate

入力パラメーター

パラメーター	ラベル	説明
branch	データスペース	指定されたデータスペースの識別子-このフィールドは、このサービスに必要です。
instance	データセット	値は、選択したデータスペースに存在するデータセットの参照である必要があります-このフィールドは、このサービスに必要です。
scope	範囲	このサービスのユーザーナビゲーションの範囲、つまり、ユーザーがセッション中に選択できるエンティティを定義します。空白のままにすると、デフォルト値が使用されます。パースペクティブの場合、デフォルト値は常に「ノード」です。ワークフローの場合、デフォルト値は選択したエンティティまたはサービスによって異なります。
trackingInfo	追跡情報	追跡情報は「履歴」ログに記録されます。また、アクセス制御や追加のエクスポート情報など、その他の目的にも使用できます。
xpath	複製するレコード（XPath）	値は、既存のレコードの有効な絶対ロケーションパスである必要があります。表記は、簡略化された構文の簡略化されたXPathに準拠している必要があります-このフィールドは、このサービスに必要です。

出力パラメーター

パラメーター	ラベル	説明
created	作成されたレコード	作成されたレコードのXPathが含まれます。

データのXMLファイルへのエクスポート

exportToXMLサービスは、エクスポートが完了してファイルがダウンロードされたときに完了したと見なされます。

サービス名パラメーター：service=@exportToXML

入力パラメーター

パラメーター	ラベル	説明
branch	データスペース	指定されたデータスペースの識別子-このサービスにはデータスペースが必要です。
instance	データセット	値は、選択したデータスペースに存在するデータセットの参照である必要があります-このフィールドは、このサービスに必要です。
scope	範囲	このサービスのユーザーナビゲーションの範囲、つまり、ユーザーがセッション中に選択できるエンティティを定義します。空白のままにすると、デフォルト値が使用されます。パースペクティブの場合、デフォルト値は常に「ノード」です。ワークフローの場合、デフォルト値は選択したエンティティまたはサービスによって異なります。
trackingInfo	追跡情報	追跡情報は「履歴」ログに記録されます。また、アクセス制御や追加のエクスポート情報など、その他の目的にも使用できます。
version	スナップショット	指定されたスナップショットの識別子-このサービスにはデータスペースが必要です。
xpath	エクスポートするデータセットテーブル（XPath）	値は、選択したデータセット内のテーブルの有効な絶対位置パスである必要があります。表記は、簡略化された構文の簡略化されたXPathに準拠している必要があります-このフィールドは、このサービスに必要です。

データのCSVファイルへのエクスポート

ワークフローは、エクスポートが完了してファイルがダウンロードされると、exportToCSVサービスが完了したと見なします。

サービス名パラメーター：service=@exportToCSV

入力パラメーター

パラメーター	ラベル	説明
branch	データスペース	指定されたデータスペースの識別子-このサービスにはデータスペースが必要です。
instance	データセット	値は、選択したデータスペースに存在するデータセットの参照である必要があります-このフィールドは、このサービスに必要です。
scope	範囲	このサービスのユーザーナビゲーションの範囲、つまり、ユーザーがセッション中に選択できるエンティティを定義します。空白のままにすると、デフォルト値が使用されます。パースペクティブの場合、デフォルト値は常に「ノード」です。ワークフローの場合、デフォルト値は選択したエンティティまたはサービスによって異なります。
trackingInfo	追跡情報	追跡情報は「履歴」ログに記録されます。また、アクセス制御や追加のエクスポート情報など、その他の目的にも使用できます。
version	スナップショット	指定されたスナップショットの識別子-このサービスにはデータスペースが必要です。
xpath	エクスポートするデータセットテーブル（XPath）	値は、選択したデータセット内のテーブルの有効な絶対位置パスである必要があります。表記は、簡略化された構文の簡略化されたXPathに準拠している必要があります-このフィールドは、このサービスに必要です。

XMLファイルからのデータインポート

ワークフローは、インポートが実行されると、importFromXMLサービスが完了したと見なします。

サービス名パラメーター：service=@importFromXML

入力パラメーター

パラメーター	ラベル	説明
branch	データスペース	指定されたデータスペースの識別子-このサービスにはデータスペースが必要です。
instance	データセット	値は、選択したデータスペースに存在するデータセットの参照である必要があります-このフィールドは、このサービスに必要です。
scope	範囲	このサービスのユーザーナビゲーションの範囲、つまり、ユーザーがセッション中に選択できるエンティティを定義します。空白のままにすると、デフォルト値が使用されます。パースペクティブの場合、デフォルト値は常に「ノード」です。ワークフローの場合、デフォルト値は選択したエンティティまたはサービスによって異なります。
trackingInfo	追跡情報	追跡情報は「履歴」ログに記録されます。また、アクセス制御や追加のエクスポート情報など、その他の目的にも使用できます。
xpath	インポートするデータセットテーブル（XPath）	値は、選択したデータセット内のテーブルの有効な絶対位置パスである必要があります。表記は、簡略化された構文の簡略化されたXPathに準拠している必要があります-このフィールドは、このサービスに必要です。

CSVファイルからのデータインポート

ワークフローは、インポートが実行されると、importFromCSVサービスが完了したと見なします。

サービス名パラメーター：service=@importFromCSV

入力パラメーター

パラメーター	ラベル	説明
branch	データスペース	指定されたデータスペースの識別子-このサービスにはデータスペースが必要です。
instance	データセット	値は、選択したデータスペースに存在するデータセットの参照である必要があります-このフィールドは、このサービスに必要です。
scope	範囲	このサービスのユーザーナビゲーションの範囲、つまり、ユーザーがセッション中に選択できるエンティティを定義します。空白のままにすると、デフォルト値が使用されます。パースペクティブの場合、デフォルト値は常に「ノード」です。ワークフローの場合、デフォルト値は選択したエンティティまたはサービスによって異なります。
trackingInfo	追跡情報	追跡情報は「履歴」ログに記録されます。また、アクセス制御や追加のエクスポート情報など、その他の目的にも使用できます。
xpath	インポートするデータセットテーブル（XPath）	値は、選択したデータセット内のテーブルの有効な絶対位置パスである必要があります。表記は、簡略化された構文の簡略化されたXPathに準拠している必要があります-このフィールドは、このサービスに必要です。

データスペースへのアクセス

ワークフローは、データスペース選択サービスが完了したと自動的に見なします。

サービス名パラメーター：service=@selectDataSpace

入力パラメーター

パラメーター	ラベル	説明
branch	データスペース	指定されたデータスペースの識別子-このサービスにはデータスペースが必要です。
scope	範囲	このサービスのユーザーナビゲーションの範囲、つまり、ユーザーがセッション中に選択できるエンティティを定義します。空白のままにすると、デフォルト値が使用されます。パースペクティブの場合、デフォルト値は常に「ノード」です。ワークフローの場合、デフォルト値は選択したエンティティまたはサービスによって異なります。
trackingInfo	追跡情報	追跡情報は「履歴」ログに記録されます。また、アクセス制御や追加のエクスポート情報など、その他の目的にも使用できます。
version	スナップショット	指定されたスナップショットの識別子-このサービスにはデータスペースが必要です。

データスペース、スナップショット、またはデータセットの検証

ワークフローは、検証サービスが完了したと自動的に見なします。

サービス名パラメーター：service=@validation

入力パラメーター

パラメーター	ラベル	説明
branch	データスペース	指定されたデータスペースの識別子-このサービスにはデータスペースまたはスナップショットが必要です。
instance	データセット	値は、選択したデータスペースに存在するデータセットの参照である必要があります。
scope	範囲	このサービスのユーザーナビゲーションの範囲、つまり、ユーザーがセッション中に選択できるエンティティを定義します。空白のままにすると、デフォルト値が使用されます。パースペクティブの場合、デフォルト値は常に「ノード」です。ワークフローの場合、デフォルト値は選択したエンティティまたはサービスによって異なります。
trackingInfo	追跡情報	追跡情報は「履歴」ログに記録されます。また、アクセス制御や追加のエクスポート情報など、その他の目的にも使用できます。
version	スナップショット	指定されたスナップショットの識別子-このサービスにはデータスペースまたはスナップショットが必要です。

出力パラメーター

パラメーター	ラベル	説明
hasError	見つけられたエラー	検証でエラーが発生した場合は、「true」が含まれます。
hasFatal	見つけられた致命的エラー	検証によって致命的なエラーが発生した場合は、「true」が含まれます。
hasInfo	見つけられた情報	検証によって情報が生成された場合は、「true」が含まれます。
hasWarning	見つけられた警告	検証によって警告が生成された場合は、「true」が含まれます。

データスペースのマージ

ワークフローは、マージが実行され、データスペースが閉じられると、マージサービスが完了したと見なします。

サービス名パラメーター：service=@merge

入力パラメーター

パラメーター	ラベル	説明
branch	データスペース	指定されたデータスペースの識別子-このサービスにはデータスペースが必要です。
scope	範囲	このサービスのユーザーナビゲーションの範囲、つまり、ユーザーがセッション中に選択できるエンティティを定義します。空白のままにすると、デフォルト値が使用されます。パースペクティブの場合、デフォルト値は常に「ノード」です。ワークフローの場合、デフォルト値は選択したエンティティまたはサービスによって異なります。
trackingInfo	追跡情報	追跡情報は「履歴」ログに記録されます。また、アクセス制御や追加のエクスポート情報など、その他の目的にも使用できます。

出力パラメーター

パラメーター	ラベル	説明
mergeResult	マージの成功	マージが成功した場合は「true」を含み、それ以外の場合は「false」を含みます。
mergeState	マージ状態	マージの戻りコードが含まれています。 InteractionMergeStateUIHttpManagerComponentReturnCodeを使用してこの値を解析することを強くお勧めします。

データスペースマージビューへのアクセス

merge.viewサービスは、自動的に完了したと見なされます。

サービス名パラメーター：service=@merge.view

入力パラメーター

パラメーター	ラベル	説明
branch	データスペース	指定されたデータスペースの識別子-このサービスにはデータスペースが必要です。
scope	範囲	このサービスのユーザーナビゲーションの範囲、つまり、ユーザーがセッション中に選択できるエンティティを定義します。空白のままにすると、デフォルト値が使用されます。パースペクティブの場合、デフォルト値は常に「ノード」です。ワークフローの場合、デフォルト値は選択したエンティティまたはサービスによって異なります。
trackingInfo	追跡情報	追跡情報は「履歴」ログに記録されます。また、アクセス制御や追加のエクスポート情報など、その他の目的にも使用できます。

内容の比較

ワークフローは、比較サービスが完了したと自動的に見なします。

サービス名パラメーター：service=@compare

入力パラメーター

パラメーター	ラベル	説明
branch	データスペース	指定されたデータスペースの識別子-このサービスには、比較するデータスペースまたはスナップショットとデータスペースまたはスナップショットが必要です。
compare.branch	比較するデータスペース	比較するデータスペースの識別子-このサービスには、比較するデータスペースまたはスナップショットとデータスペースまたはスナップショットが必要です。
compare.filter	比較フィルター	比較で継承フィールドと関数フィールドを無視するには（解決モードを無効にする）、フィルター「persistedValuesOnly」を指定する必要があります。デフォルトでは、フィルターが定義されていない場合、比較では解決モードが使用されます。
compare.instance	比較するデータセット	値は、比較するために選択したデータスペースに存在するデータセットの参照である必要があります。
compare.version	比較するスナップショット	比較するスナップショットの識別子-このサービスには、比較するデータスペースまたはスナップショットとデータスペースまたはスナップショットが必要です。
compare.xpath	比較するテーブルまたはレコード（XPath）	値は、比較するために、選択したデータセット内のテーブルまたはレコードの有効な絶対位置パスである必要があります。表記は、簡略化された構文で、簡略化されたXPathに準拠している必要があります。
instance	データセット	値は、選択したデータスペースに存在するデータセットの参照である必要があります。
scope	範囲	このサービスのユーザーナビゲーションの範囲、つまり、ユーザーがセッション中に選択できるエンティティを定義します。空白のままにすると、デフォルト値が使用されます。パースペクティブの場合、デフォルト値は常に「ノード」です。ワークフローの場合、デフォルト値は選択したエンティティまたはサービスによって異なります。
trackingInfo	追跡情報	追跡情報は「履歴」ログに記録されます。また、アクセス制御や追加のエクスポート情報など、その他の目的にも使用できます。
version	スナップショット	指定されたスナップショットの識別子-このサービスには、データスペースまたはスナップショットと、比較するデータスペースまたはスナップショットが必要です。
xpath	テーブルまたはレコード（XPath）	値は、選択したデータセット内のテーブルまたはレコードの有効な絶対位置パスである必要があります。表記は、簡略化された構文で、簡略化されたXPathに準拠している必要があります。

データワークフロー

このサービスは、データワークフローのユーザーインターフェイスへのアクセスを提供します。

サービス名パラメーター：service=@Workflow

入力パラメーター

パラメーター	ラベル	説明
scope	範囲	このサービスのユーザーナビゲーションの範囲を定義します。
viewPublication	ビューの公開	このサービスに適用するビューの公開名を定義します。
workflowView	ワークフロービュー	ワークフロービュータイプを指定します。値は、「inbox」、「launcher」、「monitoringPublications」、「monitoringWorkflows」、「monitoringWorkItems」、または「completedWorkflows」のいずれかになります。
xpath	フィルタ（XPath）	オプションのフィルター。構文は、「[」と「]」で囲まれたXPath述語に準拠している必要があります。